Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/gypsydangerous/onelink

๐Ÿ”— OneLink is a linktree and flowpage clone built with Nextjs, MongoDb, and GraphQL
https://github.com/gypsydangerous/onelink

graphql mongodb nextjs

Last synced: 6 days ago
JSON representation

๐Ÿ”— OneLink is a linktree and flowpage clone built with Nextjs, MongoDb, and GraphQL

Awesome Lists containing this project

README

        





OneLink



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 | - | - | - | - | - |
| ------- | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |
| FrontEnd |


Nextjs

|


TypeScript

|


Styled Component

|


Framer Motion

|


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.git
```

### Step 2: Install Dependencies

cd into the directory

```sh
cd OneLink
```

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