https://github.com/fernandohenriques/chat-api
API for a private chat.
https://github.com/fernandohenriques/chat-api
eslint express mongoose nodejs ramda socket-io
Last synced: 3 months ago
JSON representation
API for a private chat.
- Host: GitHub
- URL: https://github.com/fernandohenriques/chat-api
- Owner: fernandohenriques
- Created: 2018-09-04T08:37:27.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-09-06T04:25:06.000Z (over 7 years ago)
- Last Synced: 2025-04-08T15:49:29.554Z (10 months ago)
- Topics: eslint, express, mongoose, nodejs, ramda, socket-io
- Language: JavaScript
- Homepage:
- Size: 57.6 KB
- Stars: 6
- Watchers: 1
- Forks: 5
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Chat API (for [this](https://github.com/fernandohenriques/chat-app.git) front-end)
## Getting Started
Back-end project for a private chat, written with NodeJS + Express + Socket.IO + Mongoose.
### Pre requisites
```
$ node --version
v10.9.0
$ NPM --version
v6.4.0
$ MongoDB --version
v4.0.2
```
### How to Run
```
Create a database in MongoDB
git clone https://github.com/fernandohenriques/chat-api.git
cd chat-api/
Create a file called .env
Open this file and add this variables:
- PORT -> Port to API
- MONGODB_URI -> A MongoDB URI for database
npm install
npm start
```
### Running tests
#### Linter validations
```
cd chat-api/
npm run lint
```
## Built With
* [NodeJS](https://facebook.github.io/react-native/)
* [Express](http://expressjs.com/)
* [Socket.io](https://socket.io)
* [Mongoose](https://mongoosejs.com/)
* [Ramda](https://ramdajs.com/)
* [NPM](https://www.npmjs.com/)
* [ESLint](https://eslint.org/)
* [Nodemon](https://nodemon.io/)
## Author
* **Fernando Henriques** - [GitHub](https://github.com/fernandohenriques)