Muse Knoxville is a discovery-based children’s museum in Knoxville, TN. See their existing website for more information.
Frontend: React
Backend: TypeScript
Next.js: Server-side rendering, API routes, file-based routing
Content Management System(CMS): Contentful/Square
Database: MongoDB
node v14+ (recommend getting nvm to manage versions)
yarn (package manager - similar to npm)
- Clone the repository.
- Run
yarnoryarn installto update dependencies. - Run
yarn devfor development mode with hot-code reloading, error reporting, and more. - Open http://localhost:3000 with your web browser to see the result.
Note: Running yarn build then yarn start will start the application in production mode.
- Jira for issue tracking
- Figma for mockups
- Confluence for formal documents
- Square/Contentful for CMS access
- Create a new branch in the format
[GITHUB_USERNAME]/MUSE-[JIRA ISSUE NUMBER]-[SHORT_DESCRIPTION]by runninggit checkout -b [BRANCH NAME]- This way the issues are closed on Jira when we merge the PR with that branch name
rluberto/MUSE-12-init-project
- Be sure to lint, format, and type-check your code occasionally to catch errors by running
yarn lint. - Commit changes.
- Then push your branch by running
git push -u origin [BRANCH NAME]. This pushes your branch to remote. - Create a pull request (PR) on GitHub to merge your branch into
develop.mainwill serve as production. - In your PR, briefly describe the changes, then tag Trevor (trevormangrum) and Ray (rluberto) to the PR. Others are welcome to comment and give feedback as well.
components/: Contains most of our front-end code. This is where we put our React components.pages/: Contains files that are associated with a route based on its file name. For more information, see Next.js' docs.public/: Stores static files like images, see Next.js' docs.requests/: Contains files for fetching data on the client-side here.server/: Contains almost all of our backend code. This is where we put our business logic.utils/: For code used across root directories.