/nlwcopa-mobile

⚽ Mobile platform of nlwcopa application - made with react native, native base, expo

Primary LanguageTypeScriptMIT LicenseMIT

NlwCopa

Mobile Application for NlwCopa

Create your own cup pool and share it with friends!

GitHub top language Made by Repository size GitHub last commit Repository issues GitHub

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

⚽ About the project

This project 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 api client, click here: NlwCopa Api

🚀 Technologies

Technologies that I used to develop this api

💻 Getting started

Requirements

Clone the project and access the folder

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

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

# Change the address of the src/services/api.ts file by inserting the machine's IP.

# To finish, run the expo 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-mobile

Follow the steps below

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

# 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

📝 License

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


Made with 💚 by Vilmar Batista 🤝 See my linkedin