TBD
This project is set up using React and Vite to provide a minimal configuration for a smooth development experience with Hot Module Replacement (HMR) and ESLint rules. We are also using Tailwind CSS, a utility-first CSS framework, to streamline styling and ensure a responsive, modern UI.
- React: JavaScript library for building user interfaces.
- Vite: Development environment for fast builds and smooth HMR.
- Tailwind CSS: Utility-first CSS framework for rapidly building custom designs.
- Clone the repository.
- Install dependencies:
npm install - Start the development server:
npm run dev - Build the project for production:
npm run build
Feel free to customize this setup according to your project needs.
We’ve integrated Tailwind CSS for efficient and customizable styling. You can start using the utility classes provided by Tailwind in your React components right away. For more information on how to use Tailwind, check the official documentation.
To modify the Tailwind configuration, edit the tailwind.config.js file located at the root of the project.
This project is built by a talented team. You can find their GitHub and LinkedIn profiles below. In Sprint #1, team members should validate their repo access by adding their information and practicing PRs.
- Anna Bowen: GitHub / LinkedIn
- Clarissa Jaime: GitHub / LinkedIn
- Emily Arnold: GitHub / LinkedIn
- Hilda Vallapuram: GitHub / LinkedIn
- Ivan Rebolledo: GitHub / LinkedIn
- Leonardo: GitHub / LinkedIn
- Satomi Li: GitHub / LinkedIn
- Patrick Pate: GitHub / LinkedIn
Throughout the project, we have several key documents to assist with planning, communication, and organization. These documents can be found in the /docs directory.
- Voyage Kickoff Meeting: ./docs/meeting-voyage_kickoff.docx
- App Vision & Feature Planning: ./docs/meeting-vision_and_feature_planning.docx
- Sprint Retrospective, Review, and Planning: ./docs/meeting-sprint_retrospective_review_and_planning.docx
- Sprint Open Topic Session: ./docs/meeting-sprint_open_topic_session.docx
These documents are intended to help the team stay aligned and organized throughout the development process.
Remember, your project's README is as crucial as the code itself. Feel free to modify and expand this README to make it uniquely suited to your team's needs and project goals. For inspiration, check out this guide: Keys to a well-written README.