Skip to content

A simple backend api for Link Ship which allowe to create user thier account and manage thier social links

License

Notifications You must be signed in to change notification settings

Dojeto/LinkShip-Backend

Repository files navigation

LinkShip Backend

A simple backend api for Link Ship which allowe to create user thier account and manage thier social links

API Documentation - Read here

Technologies Used

  1. Nodejs
  2. Monngo DB
  3. NPM Package: express
  4. NPM Package: mongoose
  5. NPM Package: jwt
  6. NPM Package : bcrypt

Getting Started

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

Prerequisites

In order to get a copy of the project you will require you to have Node.js (v14+) and the NPM package manager installed. If you don't have it, you can download the latest version of Node.js from the official website which also installs the NPM package manager by default.

Installation

Open the terminal in the folder in which you wish to clone the repository and enter the following command:

git clone https://github.com/Dojeto/LinkShip-Backend.git .

Install all the NPM packages:

npm i

Create .env file for your Database url Make MONGO_URL valriable and set that variable to your database url In order to run the server:

npm run start

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/YourAmazingFeature)
  3. Commit your Changes (git commit -m 'Add some YourAmazingFeature')
  4. Push to the Branch (git push origin feature/YourAmazingFeature)
  5. Open a Pull Request

⚫Contributors

Dojeto

Alt

About

A simple backend api for Link Ship which allowe to create user thier account and manage thier social links

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages