okapi chat app

Okapi is a open-source social network website build with node.js and MongoDB.

Table of Contents

• About the Project
  • Features
  • To Do List
• Getting Started
  • Installation
• Contributing
• License

About The Project

Okapi is created for learning and to have fun with your friends and to add new future you like to the site by contributing.

Features

• You can sign using Google, facebook or local authentication.
• chat in a public room
• create public rooms

To Do List

• edit user profiles
• add friends
• private chat/ private rooms

Getting Started

It's simple to get started with Okapi, you just need to link you mongodb database. If you want google authentication to work you need to add your google credentials from google developers console to the .env.example.

Installation

1. Clone or download the repo
2. Install NPM packages

npm install

3. start

npm start

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

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