About   |    Layout   |    Tech Stack   |    How it works   |    License

💻 About

NLW cup is a web and mobile application in which each user can create a world cup pool and invite their friends to participate. This project was developed during Rocketseat's Next Level Week event on the Ignite trail, under the guidance of Diego Fernandes and Rodrigo Gonçalves.

---

🎨 Layout

The application layout is available on Figma link.

Web

---

Mobile

---

🛠 Tech Stack

The following tools were used in the construction of the project:

• Javascript
• Typescript
• Node.js
• Fastify
• zod
• short-unique-id
• ReactJs
• Next
• axios
• dotenv
• Native-base
• ReactNative
• Expo
• React-navigation
• Tailwindcss
• Phosphoricons
• Prisma ORM
• Vite

🚀 How it works

This project is divided into three parts:

1. Backend (server folder)
2. Frontend (web folder)
3. Mobile (mobile folder)

💡 Both Frontend and Mobile need the Backend to be running to work.

Pre-requisites

Before you begin, you will need to have the following tools installed on your machine: [Git] (https://git-scm.com), [Node.js] (https://nodejs.org/en/). In addition, it is good to have an editor to work with the code like [VSCode] (https://code.visualstudio.com/)

🎲 Running the Backend (server)

# Clone this repository
$ git clone git@github.com:exodogurgel/nlw-copa-ignite.git

# Access the project folder cmd/terminal
$ cd nlw-copa-ignite

# go to the server folder
$ cd server

# install the dependencies
$ npm install

# Run the application in development mode
$ npm run dev

# The server will start at port: 3333 - go to http://localhost:3333

🧭 Running the web application (Frontend)

# Go to the Front End application folder
$ cd web

# Install the dependencies
$ npm install

# Run the application in development mode
$ npm run dev

# The application will open on the port: 3000 - go to http://localhost:3000

📱 Running the mobile app (Mobile)

# Go to the mobile application folder
$ cd mobile

# Install the dependencies
$ npm install

# Run the application in development mode
$ npx expo start

---

🦸 Author

_{Êxodo Gurgel} 🚀

---

📝 License

This project is under the license MIT.

Made with ❤️ by Êxodo Gurgel 👋🏽 Get in Touch!