The nlwcopa-api from vilmarsitiodigital

nlwcopa-api's Introduction

Fastify Application for NlwCopa project

Create your own cup pool and share it with friends!

About the project | Technologies | Getting started | How to contribute | License

⚽ About the project

This API provides everything needed to organize pools among your friends.

Players can choose the best guess between games.

Providers can see all their pools, view the games, participants and predictions.

To see the web client, click here: NlwCopa Web
To see the mobile client, click here: NlwCopa Mobile

🚀 Technologies

Technologies that I used to develop this api

💻 Getting started

Import the Insomnia.json on Insomnia App or click on Run in Insomnia button

Requirements

Node.js
Npm

Clone the project and access the folder

$ git clone https://github.com/vilmarsitiodigital/nlwcopa-api.git && cd nlwcopa-api

Follow the steps below

# Install the dependencies
$ npm i

# Make a copy of '.env.example' to '.env'
# and set with YOUR environment variables.
# The aws variables do not need to be filled for dev environment
$ cp .env.example .env

# Once the services are running, run the migrations
$ npx prisma migrate dev

# To finish, run the api service
$ npm run dev

# Well done, project is started!

🤔 How to contribute

Make a fork of this repository

# Fork using GitHub official command line
# If you don't have the GitHub CLI, use the web site to do that.

$ gh repo fork vilmarsitiodigital/nlwcopa-api

Follow the steps below

# Clone your fork
$ git clone your-fork-url && cd nlwcopa-api

# Create a branch with your feature
$ git checkout -b my-feature

# Make the commit with your changes
$ git commit -m 'Feature: My new feature'

# Send the code to your remote branch
$ git push origin my-feature

After your pull request is merged, you can delete your branch