Skip to content

Latest commit

 

History

History
103 lines (71 loc) · 2.32 KB

readme.md

File metadata and controls

103 lines (71 loc) · 2.32 KB
Raw

ConvoyChat Logo ConvoyChat Logo

Help us take over the world

Travis (.com) GitHub Twitter Follow

View Demo · Report Bug · Request Feature

Real time group messaging app

✨ Features

  • WIP

Tech Stack

  • Pending

🚀 Quick start

Start developing locally.

Step 1: Clone the repo

Fork the repository. then clone the repo locally by doing -

git clone https://github.com/anuraghazra/convoychat.git

Step 2: Install Dependencies

cd into the directory

cd convoychat

In the root folder do npm install.

npm install
# also in client
cd client & npm install

Step 3: Setup .env

To run the server you will also need to provide the .env variables

  • create a new file .env in the root
  • open .env.EXAMPLE
  • copy the contents and paste it to the .env with valid keys

And you are good to go

npm run develop

✌️ Contributing

After cloning & setting up the local project you can push the changes to your github fork and make a pull request.

You can also run the tests locally to see if everything works fine with

Running tests

npm run test
npm run cy:open

Pushing the changes

git add .
git commit -m "feat: added new stuff"
git push YOUR_REPO_URL develop

Made with ❤️ and javascript