Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gypsydangerous/onelink-backend
⚡ Backend API for OneLink (https://github.com/GypsyDangerous/OneLink), a social media sharing app similar to linktree and flowpage
https://github.com/gypsydangerous/onelink-backend
graphql typescript
Last synced: 11 days ago
JSON representation
⚡ Backend API for OneLink (https://github.com/GypsyDangerous/OneLink), a social media sharing app similar to linktree and flowpage
- Host: GitHub
- URL: https://github.com/gypsydangerous/onelink-backend
- Owner: GypsyDangerous
- License: mit
- Created: 2020-12-02T00:34:27.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2021-01-20T16:27:12.000Z (almost 4 years ago)
- Last Synced: 2024-05-01T19:15:16.624Z (7 months ago)
- Topics: graphql, typescript
- Language: TypeScript
- Homepage:
- Size: 436 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
·
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
|
## :rocket: Quick start
Start developing locally.
### Step 1: Clone the repo
Fork the repository. then clone the repo locally by doing -
```sh
git clone https://github.com/GypsyDangerous/OneLink-backend.git
```
### Step 2: Install Dependencies
cd into the directory
```sh
cd OneLink-backend
```
In the root folder do npm install.
```sh
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](./.env.sample)
- copy the contents and paste it to the .env with valid keys
#### And you are good to go
```sh
npm run dev
```
## :v: 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
```bash
npm run test
```
### Pushing the changes
```bash
git add .
git commit -m "feat: added new stuff"
git push YOUR_REPO_URL develop
```
---
Made with :heart: and javascript