Skip to content

Full-stack real-time messaging app I've made to learn more about socket.io, node.js and API's.

Notifications You must be signed in to change notification settings

andrewsolonets/TheChatApp

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

44 Commits
 
 
 
 
 
 
 
 

Repository files navigation


Logo

The Chat App

Full-stack real-time messaging app I've made to learn more about socket.io, node.js and API's.

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About The Project

Product Name Screen Shot

A simple chat app that persists current users via cookies, saves message history in MongoDB. I've built this app to learn more about the backend - specifically node.js, express, and socket.io. I was amazed by the power of sockets, which led me to building this project. Server has an API that handles user authentication as well as message receiving, creating and storing functionality. MongoDb is used as a database.

(back to top)

Built With

  • Next
  • React

(back to top)

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

Getting Started

Client side:

First, create .env file with NEXT_PUBLIC_HOST=http://localhost:3001

Second, install dependencies: npm install

Third, run the development server:

npm run dev

# or

yarn dev

Open http://localhost:3000 with your browser to see the result.

Server side:

  1. Install dependencies: npm install
  2. Create .env file with: PORT=3001, TOKEN_KEY(jwt secret) TOKEN_EXPIRES_IN ORIGIN='http://localhost:3000'(client url) MONGO_URL(mongo connection url)
  3. npm start

Usage

(back to top)

Roadmap

  • Socket.io integration
  • DB users and messages persistence
  • Cookies for user log-in

(back to top)

Contributing

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

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  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

(back to top)

Contact

Project Link: https://github.com/andrewsolonets/TheChatApp

(back to top)

About

Full-stack real-time messaging app I've made to learn more about socket.io, node.js and API's.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published