Skip to content
Snippets Groups Projects
Commit 38eea245 authored by Richard Fernando Heise Ferreira's avatar Richard Fernando Heise Ferreira
Browse files

Merge branch 'wps20-develop-patch-24482' into 'develop'

Update README.md

See merge request !13
parents 59d53c57 3d12cd97
1 merge request!13Update README.md
# Open Chess Back-End
## Description
This is the Back-End application for the Open Chess project.
It relies on GraphQL and Prisma.
## Files
### Files
server.js: The main file of the application.
src/typedefs/typeDefs.js: Type definitions used by GraphQL.
src/resolver/resolvers.js: Implementations of the types defined in typeDefs.js.
src/typedefs/: Types definitions used by GraphQL.
src/resolvers/: Implementations of the types defined in src/typedefs/.
prisma/schema.prisma: Schema used by Prisma to configure the Postgres DB.
## Running the application
### Running the application
To install the dependencies to run the application, execute the following commands inside its directory:
```shell
$ sudo apt install docker-compose
$ docker-compose up -d
$ sudo apt install docker
$ sudo apt install docker-compose-plugin
$ docker compose up -d
$ npm install
```
To set up a local database, execute the following:
```shell
$ npx prisma migrate dev --name "nome" --create-only
$ npx prisma migrate dev
$ npx prisma db push
```
To run the application, execute one of the lines below:
To run the application, execute the line below:
```shell
$ npm run dev
$ npm start
```
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment