getting-started.md

Getting Started

Welcome to the getting started page! Here is all you need to know to get this repo up and running on your local machine, as well as good collaborative coding practices

Contents

• Setup for All Developers
• Helpful commands
• Project Structure

Setup for all Developers

1. Clone this repository git clone <repo-url>
2. Run npm i in the frontend directory of the repository
3. Create an .env.local file and retrieve secrets from your tech lead
4. Install IDE Extensions
   • Prettier
   • ESLint
5. Enable format on save in your IDE
   1. Click the settings button in the bottom left
      
   2. Search "formatter" and set your default formatter to Prettier
   3. Search "format on save" and click the checkbox
6. Familiarize yourself with Helpful Commands, the Project Structure, and the steps for contributing.

Helpful commands

• npm run dev: Start your local development environment at http://localhost:3000
• npm run lint: make sure Prettier and ESLint pass
• npm run lint:fix: make sure Prettier and ESLint pass and try to automatically fix all issues (some ESLint issues must be resolved manually)
• git stash: Temporarily remove all local changes to a branch and save them. Good when you need to hop to another branch without committing your current code.
• git stash apply: Reapply most recent git stash.
• git merge orgin/master: Pull all changes from the main branch to yours, good for resolving merge conflicts.

Project Structure

• .github Github Actions CI/CD and Issue/PR templates
• docs Documentation - Documentation for getting started and developing
• frontend All frontend code and configuration
  • src All application code for frontend
  • app Frontend and API code
    • api All API routes
    • components All React components
      • ui Shadcn ui components
    • /* App router routes for pages
    • styles All CSS files
  • database MongoDB schemas for data fetching and authentication
• backend All backend code for AWS Chalice project

This is a Next.js project bootstrapped with create-next-app. It's built alongside an AWS Chalice backend to handle web scraping.

Learn More about Next.js

To learn more about Next.js, take a look at the following resources:

• Next.js Documentation - learn about Next.js features and API.
• Learn Next.js - an interactive Next.js tutorial.
• NextAuth Documentation - learn about authentication and authorization with NextAuth

You can check out the Next.js GitHub repository - your feedback and contributions are welcome!

Learn More about AWS Chalice

To learn more about AWS Chalice, take a look at the following resources:

• AWS Chalice Documentation - learn about Chalice features and API.