miko

Linked List

The one stop solution to managing all your social media influence on a single platform.

📃 About The Folder

This Folder is called Miko named after Hololive character Sakura Miko. This folder contains the official Backend API for Linked List.

🧩 Getting Started

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

Starting the development server with docker 🐳

Prerequisites

Make sure you have Docker and docker-compose installed on your machine.

Steps to start the server

1. Run the following command in the root directory itself to build the Docker Environment and lateron use the same command to spin the Docker Environment without the build flag.

   docker-compose -f ./docker-compose.debug.yml up --build

2. Your server should be running on port 5000.

Starting the development server without docker 📡

Prerequisites

Make sure you have Node, Redis and TypeScript installed on your machine.

NOTE:

_The project was made with node version 14.15.1

Steps to start the server

1. Add environment files in backend directory.

   miko/.env file

   NODE_ENV=development
   
   MONGO_URI=
   
   DB_HOST=
   DB_PORT=
   DB_USERNAME=
   DB_PASSWORD=
   DB_DATABASE=
   
   REDIS_URI=
   
   
   LINKEDLIST_ACCESS_TOKEN_SECRET=
   LINKEDLIST_REFRESH_TOKEN_SECRET=
   
   
   LINKEDLIST_API_GOOGLE_CLIENT_ID=
   LINKEDLIST_API_GOOGLE_CLIENT_SECRET=
   LINKEDLIST_API_GOOGLE_CALLBACK_URL=
   
   LINKEDLIST_GITHUB_CLIENT_ID=
   LINKEDLIST_GITHUB_CLIENT_SECRET=
   LINKEDLIST_GITHUB_CALLBACK_URL=
   
   MAIL_USER=
   MAIL_PASSWORD=

2. To install all the dependencies run the following command in backend directory.

   yarn 

3. Run the following command in to buid the dist directory.

   yarn build

4. Run the following command in to start server.

   yarn dev

5. Your server should be running on port 5000.

🔐 License

This project is licensed under the MIT License - see the LICENSE file for details.