Josh-McFarlin/carbdash-server

Server for team Carbdashian

Carbdash Server

---

👋 Intro

• Backend for team Carbdashian of Mobile Apps and Services at Georgia Tech

🗒️ Details

• Repo: https://github.com/josh-mcfarlin/carbdash-server
• Authors:
  • Joshua McFarlin
  • Vidushi Jain
  • Lauren Tapp
  • Devin Raun

🖥️ Stack

• Deployment to AWS using Serverless
• Typing with Typescript
• Testing with Jest
• Linting with ESLint
• Formatting with Prettier
• Linting, typechecking, and formatting on commits using husky

🚀 How to use

Install

1. Clone this repo on your local machine by entering the following command in terminal: git clone https://github.com/josh-mcfarlin/carbdash-server
2. Navigate to this project in terminal and enter npm install

Running

1. Setup the project using the instructions above
2. Then enter one of the following commands in terminal:

npm install
npm run run-local

# or

yarn
yarn run-local