anastr0/RocketMeet-server

Server for RocketMeet — a powerful, open source meeting scheduling app

Find the best time for team meetings and one-on-ones with RocketMeet. Try now!

[Under active development]

Community

Come say hello at our chatroom for discussions, voicing new ideas or getting help!

API Documentation

You can find the API documentation here.

Getting Started

Prerequisites

• NodeJS v14
• MongoDB v4.4

Installation

$ git clone https://github.com/<your-username>/RocketMeet-server.git

$ cd RocketMeet-server

$ npm install

Setup

Go to Firebase and create a new project. In the authentication section at Firebase, enable sign-in with Google. Then generate a private key from your Project Overview > Project Settings > Service Accounts > Firebase Admin SDK. Next, make a copy of the .env.example file to .env and set the vars corresponding to your Firebase project. Generate and set the public encryption key and IV variables too which is used for email encryption.

Run

Make sure to start MongoDB first. Then run the RocketMeet-server using:

$ npm run dev

You will be able to access the API from http://localhost:5000

Testing

$ npm run test

Linting

We use the airbnb-typescript style guide. Before opening a PR, it's recommended to check the ESLint warnings and errors in your code using the ESLint extension from Dirk Baeumer for VSCode or by running:

$ npm run lint

Deployment

In your .env, change the NODE_ENV to production. Launch a MongoDB Atlas instance and set the corresponding DB_HOST, DB_USER and DB_USER_PWD variables in the .env. Set the CORS_URL to the domain pointing to RocketMeet-client. Make sure to add that domain to the 'Authorized domains' section in your Firebase project. Make sure the Firebase and email encryption variables are set and correct.

Contributing

Check out our contributing guide!

License

RocketMeet-server is distributed under the MIT License.