Skip to content

⚡ Backend API for OneLink (https://github.com/GypsyDangerous/OneLink), a social media sharing app similar to linktree and flowpage

License

Notifications You must be signed in to change notification settings

GypsyDangerous/OneLink-backend

Repository files navigation


OneLink Server

License Twitter Follow

· Report Bug · Request Feature

The only Link you will ever need in your bio. Share all your socials and other links through OneLink.

✨ Features

  • WIP

Tech Stack

Stack - - - - -
BackEnd


Nodejs


MongoDB


Heroku


Express


Graphql

🚀 Quick start

Start developing locally.

Step 1: Clone the repo

Fork the repository. then clone the repo locally by doing -

git clone https://github.com/GypsyDangerous/OneLink-backend.git

Step 2: Install Dependencies

cd into the directory

cd OneLink-backend

In the root folder do npm install.

npm install

Step 3: Setup .env

To run the server you will also need to provide the .env variables

  • create a new file .env in the root
  • open .env.sample
  • copy the contents and paste it to the .env with valid keys

And you are good to go

npm run dev

✌️ Contributing

After cloning & setting up the local project you can push the changes to your github fork and make a pull request.

You can also run the tests locally to see if everything works fine with

Running tests

npm run test

Pushing the changes

git add .
git commit -m "feat: added new stuff"
git push YOUR_REPO_URL develop

Made with ❤️ and javascript

About

⚡ Backend API for OneLink (https://github.com/GypsyDangerous/OneLink), a social media sharing app similar to linktree and flowpage

Topics

Resources

License

Stars

Watchers

Forks