DevScout

📃 About The Project

A New way to find dev teams for your startup

🏗️ Built With

• 📡 NodeJs
• 🗃 PostgreSQL
• 🏷 TypeScript

🧩 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 project 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 and TypeScript installed on your machine.

NOTE:

_The project was made with node version 14.16

Steps to start the server

1. Add environment file.

   .env file

   NODE_ENV=development
   PORT=5000
   PG_PORT=<postgres port number>
   HOST=<hostname>
   USERNAME=<username>
   PASSWORD=<password>

2. To install all the dependencies run the following command.

   yarn install

3. Run the following command in to start server.

   yarn dev

4. Your server should be running on port 5000.

🔐 License

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