Beavs.ai - Backend

About

This is the backend for the Beavs.ai project. This is where the backend services and api will be.

Getting Started

Prerequisites

• Node.js with npm
• MongoDB
• Git
• Visual Studio Code (recommended, but not required)

Installation

1. Clone the repo

git clone https://github.com/OSU-App-Club/beavsAI-backend.git

2. Change directory into the project

cd beavsAI-backend

3. Install required dependencies

npm install

4. Get the environment variables

Create a .env file in the /config/ directory under .env.local and add the following variables:

PORT=8080
MONGODB_ACESS=YOUR_MONGODB_ACCESS_STRING
CLERK_SECRET_KEY=your_secret_key

To get the MongoDB and Clerk access string, add your email here.

Although, you can work locally by using mongosh, MongoDB's shell.

Usage

Running the server

npm run dev

Navigate to http://localhost:8080 (or whatever port is listed in terminal) to see the server running.

License

Distributed under the MIT License. See LICENSE for more information.

Contact

This project is being developed by the Oregon State University App Development Club