/darcy-backend

The API used at the Darcy social network. Powered by Prisma and fastify

Primary LanguageTypeScriptApache License 2.0Apache-2.0

Darcy Social Network 🚀

Darcy is a social network that connects people from all over the world 🌎. Share your thoughts, photos, and interests with your friends and family 💬.

Getting Started 💻

These instructions will help you get a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites 🔧

Installing 💾

⚠️ Darcy is just a hobby project and should not be used in production.

⚠️ If you want to use it in production, you should integrate it with a object storage service.

  1. Clone the repository:
git clone https://github.com/darcyinc/darcy-backend.git
  1. Navigate to the project directory:
cd darcy-backend
  1. Install the dependencies:
pnpm install

  1. Rename the .env.example file to .env and fill in the environment variables.

  2. Generate the Prisma client:

pnpm prisma generate
  1. (Optional) Migrate your database:
pnpm prisma migrate dev

or

pnpm prisma migrate deploy

Building the Project 🏗️

Use the following command to build the project:

pnpm build

Running the Project 🏃‍♂️

Use the following command to start the project in development mode (all microservices):

make start-dev

Use the following command to start the project in production mode (a screen will be created for each microservice, Linux only):

make start-prod

⚠️ Note: only the api and the cdn applications are exposed to the internet. By default, the api application runs on port 4000 and the cdn application runs on port 2006.

⚠️ Do not expose the microservices to the internet (they don't have some validations), so try to keep everything local.

Built With 🛠️

Contributing 🤝

We welcome contributions from the community! If you're interested in contributing, please read CONTRIBUTING.md for more information.

License 📃

This project is licensed under the Apache 2.0 License.