Armada's backend server is built with Express and utilizes Prisma and the Amazon Web Services' (AWS) Software Development Kit (SDK) to communicate with all the pieces of Armada's architecture, including the Relational Database Service (RDS), the Application Load Balancer (ALB), the Elastic Container Service (ECS), and more!
To get started:
- Clone the GitHub repository.
gh repo clone team-armada/armada-backend
cd armada-backend
- Set the appropriate environmental variables in a
.env
file.
PORT=3000
AWS_REGION=us-east-1
AWS_IAM_ACCESS_KEY_ID="your-access-key"
AWS_IAM_SECRET_ACCESS_KEY="your-secret-key"
DATABASE_URL="your-postgres-url"
USER_POOL_ID="aws-cognito-url"
USER_POOL_WEB_CLIENT_ID="aws-cognito-user-pool-url"
- Install all dependencies.
npm install
- Start the development server.
npm run dev
- The
api
server will be available for requests based on the port set in.env
.