Skip to content

Latest commit

 

History

History
80 lines (65 loc) · 2.97 KB

README.md

File metadata and controls

80 lines (65 loc) · 2.97 KB

ChatApp

Build Status Coverage Status Maintainability

ChatApp Challege Project

ChatApp is a web chat application which allow people to communicate in real time using their browser. this application can be compotible with all available browser.

I developed UI for Fronted in Reactjs and also i developed API for this project to functionality.

Here is important pages you should first on my project.

  • Home page.
  • Sing up page, after sign up you will be redirected to signin page.
  • Sign in page.
  • User dashboard,where you should chat with your freinds.

HOW DO I CHAT WITH MY FREINDS ON THIS APP

Start to communicate with your freinds by clicking on sigbup and register your acccount, sign in with you user name and password to start chat.

  • To see ChatApp simply click on this link

ChatApp Back-End

Here is a list of all API Endpoints that you will find:

  • POST /api/v1/signup: before you do anything first create an account.
  • POST /api/v1/login: if you already have an acount you can use this EndPoint to sign in.
  • GET /api/v1/getall : This EndPoint wiil help you to display all users available.
  • GET /api/v1/getall/:id : this EndPoint is for specific user.
  • POST /api/v1/messages : this Endpoint is for user want to send message.
  • POST /api/v1/messages/:receiver_id : this Endpoint is for user want to see messages have sent to specific user.

Technology tools used in this Project

  • Server side Framework : Node/Express
  • Linting Library: ESLint
  • Style Guide: Airbnb
  • Testing Framework: Mocha
  • Database: Postgresql
  • Hosting API: Heroku
  • Hosting UI: Netlify

Additional Tools

  • JavaScript Es6 with Babel compiler
  • TravisCI for Continous Integration
  • nyc for test coverage
  • PivotTrack for managing a user stories
  • Heroku for Deployment
  • Reactjs for UI

Here there is important link you may visit

Setup project locally

$ To move into folder

$ cd ChatApp

Install dependincies as they appear in package.json file by

$ npm install

To start the server do

$ npm run dev-start

To run the test do

$ npm run test

Author

Kevin KIMENYI

Mentor

Eric Serge Uwimana