Skip to content

Latest commit

 

History

History
144 lines (101 loc) · 3.89 KB

README.md

File metadata and controls

144 lines (101 loc) · 3.89 KB

LinkedIn


Simple Messenger

A web-based realtime chat with authentication.
Explore the docs »

View Demo · Report Bug · Request Feature

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

About The Project

This project was developed to practice my full-stack skills.

Built With

Getting Started

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

Installation

  1. Clone the repo 
    git clone https://github.com/arshiahsn/simple-messenger.git
  2. Download and Install NodeJS
  3. Run NPM install 
    npm install

Running

npm run start

Usage

Open your browser and navigate to:

localhost:3000/

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.

Contact

Your Name - @400_bad_req - arshiahsn@gmail.com

Project Link: https://github.com/arshiahsn/simple_api