It's On is a social app that allows people to signal to groups of their friends or followers that something is happening.
- Install Node.js v18
- Use Node Version Manager to manage node versions if you already have a different version of node.js installed
-
Install the AWS SAM CLI (Stands for Amazon Web Services Serverless Application Model Command Line Interface)
-
Install dependencies (Must be done from backend and frontend directories, not the root directory)
yarn
- Start in the frontend directory
cd frontend - Start the Vite dev server
yarn dev - Lint
yarn lint - Run typescript compiler
tsc - Run unit tests
yarn test
- Start in the backend directory
cd backend - Lint
yarn lint - Run typescript compiler
tsc - Run unit tests
yarn test
AWS SAM has a way to run the backend on your computer.
sam local start-api
Once the api is running on your machine, you can use the api locally with the given port. For example,
curl http://localhost:3000/
TODO: Add instructions for using authentication (or getting around it) for development
Generated project outline by AWS SAM Generated project outline by create-react-app