MartinKondor / ninja-server

NINJA is an ultra secure messaging platform. Built with the MERN stack.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

🥷 ninja-server

Project Status version GitHub Issues Contributions welcome License

NINJA is an ultra secure messaging platform. Built with the MERN stack.

Getting Started

Prerequisites

  • Node.js v16.13.0+
  • In the main directory run the npm i command to simply install the dependencies.

Usage

For the client side (React), see: https://github.com/MartinKondor/ninja-client/.

To run the project make sure to do the following steps:

  1. You have to define a few environmental variables before run:
ATLAS_URI=...  # MongoDB atlas url
PORT=...  # Port to run on
API_KEY=...  # Api key for requests

Put them in the config.env file in the main directory.

  1. Then start the server with the npm start command.
  2. Setup and start the client side.
  3. Now you can edit the files on both sides.

Contributing

This project is open for any kind of contribution from anyone.

Steps

  1. Fork this repository
  2. Create a new branch (optional)
  3. Clone it
  4. Make your changes
  5. Upload them
  6. Make a pull request here

Authors

License

Copyright © 2022 Martin Kondor.

See the LICENSE file for details.

About

NINJA is an ultra secure messaging platform. Built with the MERN stack.

License:BSD 3-Clause "New" or "Revised" License


Languages

Language:JavaScript 100.0%