samuelematias/nlw-esports

NLW eSports 🎮👾 | Rocketseat 🧑🏾‍🚀🚀💜

NLW eSports

Topics 📋

• About 📖
• Functionalities 🛠️
• Resources 📋
• Running the project locally 🔨
• How to Contribute 💪🏾
• Contributors 🚀

---

About 📖

This project was developed at NLW, A.K.A Next Level Week, eSports an intense week of studies, networking, friendship, group work, accompanied by a sensational project developed by Rocketseat from the 12th to the 18th of June.
This application is a is an application where you can find people to play with you.
In the Web application, developed in ReactJs, you can register ads in several games, that you have interest and availability to play with someone.
In the Mobile application, developed in React Native, you can see people's ads in several games and connect with them via Discord.
All this being managed by the Backend server that we developed in NodeJs.

---

Functionalities 🛠️

• Web App (ReactJS w/ Vite)
  • List available games;
  • Register your announcement of availability to play with someone;
• Mobile App (React Native w/ Expo)
  • List available games;
  • List availability announcements to play with someone;
• Backend (NodeJS w/ Express)
  • Make the endpoints available;
  • Save data to a SQL database via Prisma;

---

Resources 📋

• NLW eSports - Ignite 📚

---

Running the project locally 🔨

Backend server 🛣

First of all, correctly configure the NodeJS development environment on your machine, see https://efficient-sloth-d85.notion.site/Instalando-o-Node-js-25018081f5e1435e970b2a8b35cd15f6.

- Clone this repository:
$ git clone https://github.com/samuelematias/nlw-esports.git

- Enter in directory:
$ cd nlw-esports

- Enter in server directory:
$ cd server

- For install server dependencies:
$ npm install

- Run the server:
 $ npm run dev

Web app 🖥

First of all, its necessary stay with the Backend up, so follow the previous Tutorial about Starup the Backend server.

Second of all, correctly configure the ReactJS development environment on your machine, see https://reactjs.org/docs/getting-started.html.

- With the Backend server Up, Enter in the main directory:
$ cd nlw-esports

- Enter in web directory:
$ cd web

- For install server dependencies:
$ npm install

- Run the server:
 $ npm run dev

Mobile app 📱

First of all, its necessary stay with the Backend up, so follow the previous Tutorial about Starup the Backend server.

Second of all, correctly configure the React Native development environment on your machine, see https://reactnative.dev/docs/0.60/enviroment-setup, and the Expo development environment on your machine, see https://efficient-sloth-d85.notion.site/Instalando-Expo-9b0abcb12bd548278e042d00fbde67f2.

Third of all, its necessary change the ip address in the constants file (mobile/src/utils/constants.ts), ADDRESS variable, to your ip address, check you ip address running ifconfig in your terminal, but don't replace the last numbers in the address, 3333, this is the server port.

- With the Backend server Up, Enter in the main directory:
$ cd nlw-esports

- Enter in web directory:
$ cd mobile

- For install server dependencies:
$ npm install

- Run the server:
 $ npm start

 - Run the simulador/emulator:
 $ yarn ios

     Or

 $ yarn android

---

How to Contribute 💪🏾

- Fork the project

- Create a new branch with your changes:
$ git checkout -b feat/my-feature

- Save your changes and create a commit message telling you what you did:
$ git commit -m "feat: implement my-feature"

- Submit your changes:
$ git push origin feat/my-feature

---

Contributors 🚀

Samuel Matias 💻 🎨