Git Product home page Git Product logo

betchat's Introduction

BetChat

Nodejs social media application. Behind the scene it uses Nodejs, Express and MongoDB, see https://bechat-app.herokuapp.com/ to use the application in staging environment.

Dependecies

NodeJs - A JavaScript runtime environment
Express - A NodeJs framework
MongoDB - A NoSQL database

Setup and run

to setup this project, run the following commands on your terminal

1. to clone the project `git clone https://github.com/sambayour/BetChat`
2. navigate to the project directory `cd BetChat`
3. install neccesary packages, modules `npm install`
4. create a `.env` file and copy the content of `env.example` to it. (remember to replace the variables with your own details).
5. to run the project `npm start`

6. using POSTMAN you can use this default url of `http://localhost:5000`
7. find `BetChat.postman_collection.json` in the project root directory for the postman colllection.

I recommend that you use POSTMAN for testing this api or you can hook it up with any front-end application.

##Endpoints

Register {POST} http://betchat-app.herokuapp.com/api/auth/register

Login {POST} http://betchat-app.herokuapp.com/api/auth/login

Add Post {POST} http://betchat-app.herokuapp.com/api/post

Get Post {GET} http://betchat-app.herokuapp.com/api/posts

My Profile {GET} http://betchat-app.herokuapp.com/api/users/621e7b3b6fb43bdd5eec0ec8

If you are running the application locally, replace http://betchat-app.herokuapp.com with your localhost url in the endpoint.

Author

Samuel Olubayo

betchat's People

Contributors

sambayour avatar

Stargazers

 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.