mirror of
https://github.com/IT4Change/Ocelot-Social.git
synced 2025-12-13 07:45:56 +00:00
80 lines
1.5 KiB
Markdown
80 lines
1.5 KiB
Markdown
# Backend Installation
|
|
|
|
{% hint style="warning" %}
|
|
This documentation should be split into a **local** and a **docker** installation variant. Also maybe there should be a main docker installation guide for the whole system at once!?
|
|
{% endhint %}
|
|
|
|
### Clone Repository
|
|
|
|
The Backend Repository can be found on github.
|
|
[https://github.com/Human-Connection/Nitro-Backend](https://github.com/Human-Connection/Nitro-Backend)
|
|
|
|
```bash
|
|
git@github.com:Human-Connection/Nitro-Backend.git
|
|
```
|
|
|
|
### Copy Environment Variables
|
|
|
|
```bash
|
|
cp .env.template .env
|
|
```
|
|
|
|
Configure the file `.env` according to your needs and your local setup.
|
|
|
|
### Install Dependencies
|
|
|
|
{% tabs %}
|
|
{% tab title="Yarn" %}
|
|
```bash
|
|
yarn install
|
|
```
|
|
{% endtab %}
|
|
|
|
{% tab title="NPM" %}
|
|
```bash
|
|
npm install
|
|
```
|
|
{% endtab %}
|
|
{% endtabs %}
|
|
|
|
### Start the Server
|
|
|
|
{% tabs %}
|
|
{% tab title="Yarn" %}
|
|
#### Development
|
|
|
|
```bash
|
|
yarn run dev
|
|
```
|
|
|
|
#### Production
|
|
|
|
```bash
|
|
# you will need to build the app first (done while building the docker image)
|
|
yarn run build
|
|
# run after build (dist folder must exist)
|
|
yarn run start
|
|
```
|
|
{% endtab %}
|
|
|
|
{% tab title="NPM" %}
|
|
#### Development
|
|
|
|
```bash
|
|
npm run dev
|
|
```
|
|
|
|
#### Production
|
|
|
|
```bash
|
|
# you will need to build the app first (done while building the docker image)
|
|
npm run build
|
|
# run after build (dist folder must exist)
|
|
npm run start
|
|
```
|
|
{% endtab %}
|
|
{% endtabs %}
|
|
|
|
This will start the GraphQL service \(by default on [http://localhost:4000](http://localhost:4000)\) where you can issue GraphQL requests or access GraphQL Playground in the browser
|
|
|