namansamra/RocketMeet-client

Client for RocketMeet — a free and open source meeting scheduling app

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

[Under active development]

Table of contents

• Community
• API Documentation
• Getting Started
• Prerequisites
• Installation
• Setup
  • Development
  • Testing
  • Production
• Deployment
  • Deploy with vercel
• Contributing
• License

Community

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

API Documentation

You can find the API documentation for the server here and the mailer here.

Getting Started

Prerequisites

• NodeJS v14

Installation

• Fork the repository

$ git clone https://github.com/<your-github-handle>/RocketMeet-client.git

$ cd RocketMeet-client

$ npm i

Setup

• Make a copy of the .env.development.example and .env.production.example files to .env.development and .env.production files respectively.
• Create a firebase account , setup firebase authentication for google sign-in (firebase-console > Authentication > Sign-in methods > Google ), whitelist the client domain in the Authorised domains section. Set firebase config variables in .env files.
• Set the encryption variables and domain URLs in the .env files

Development

Make sure that the RocketMeet-server and RocketMeet-mailer, are located at the level same as this repository with their relevant node_modules installed.

The structure should like the following:
/
├── RocketMeet-server/
├── RocketMeet-mailer/
└── RocketMeet-client/

$ npm run script

Linting

$ npx eslint . --ext .tsx,.ts

Note: Or simply setup automatic linting in vscode

Testing

$ npm run test

Production

$ npm run build

$ npm start

Deployment

Make a copy of the .env.production.example file to .env.production and set the environment variables.

Deploy with vercel

Note: You need to have the RocketMeet-server and RocketMeet-mailer setup before using this one-click deployment. Make sure to create a firebase account and setup firebase-auth for google signin.

Set the environment variables in .env.production.example at Vercel in the next step.

Contributing

Check out our contributing guide!

License

RocketMeet-client is distributed under the MIT License.