Skip to content

Latest commit

 

History

History
173 lines (123 loc) · 8.39 KB

README.md

File metadata and controls

173 lines (123 loc) · 8.39 KB
Raw

Project logo

pass.in

Português

📝 Tabela de conteúdos

🧐 Sobre

O pass.in é uma aplicação de gestão de participantes em eventos presenciais. A versão mobile permite aos participantes emitirem uma credencial em forma de QR-Code para check-in no dia do evento..
Ele foi construído durante o evento "Next Level Week Unite" da Rocketseat, na trilha de React Native.
A aplicação foi construída utilizando Typescript, tailwindcss, zustand nativewind e outras tecnologias.

🏁 Iniciando a aplicação

Essas instruções vão te permitir obter uma cópia do projeto e rodar a aplicação localmente para propósitos de desenvolvimento e teste.

Pre-requisitos

Para rodar a aplicação, você precisa ter o Node.js instalado na sua máquina. Você pode baixar o Node.js aqui.
Você também precisa ter o Git instalado na sua máquina. Você pode baixar o Git aqui.

Instalação

Para acessar o projeto, basta clonar o repositório ou realizar o download dos arquivos do projeto.
Para clonar o repositório, utilize o seguinte comando no seu terminal:

https://github.com/JsExpertCoder/nlw-unite-react-native.git

Após clonar o repositório, acesse a pasta mobile e instale as dependências utilizando o seguinte comando no seu terminal:

npm install

Após instalar as dependências da pasta mobile você pode rodar o app utilizando o seguinte comando no seu terminal(estando na pasta mobile):

npx expo start

Após isso, basta teres instalado o app Expo Go no dispositivo físico e fazer scan do QR-Code que aprecer no terminal. Você pode encontrar o Expo Go na loja do seu Smartphone aqui.

Depois disso acesse a pasta server e instale as dependências utilizando o seguinte comando no seu terminal:

npm install

Após instalar as dependências da pasta server, ainda estando nesta pasta utilize o seguinte comando no seu terminal para iniciar o servidor:

npm run dev

Após rodar o servidor, você pode acessar uma interface gráfica pra visualizar os dados no banco de dados rodadndo o seguinte comando no ser terminal (na pasta server):

npx prisma studio

Com isso, o servidor estará rodando em http://localhost:3333, e o Prisma Studio (a interface gáfica) em http://localhost:5555, para acessar, basta acessar esse endereço no seu navegador.

⛏️ Tecnologias

  • ReactJS - Biblioteca de JavaScript para construção de interfaces.
  • React Native - Uma framework poderosa desenvolvida pelo Facebook que permite aos desenvolvedores construir aplicativos móveis utilizando JavaScript.
  • Expo - Ferramenta utilizada no desenvolvimento mobile com React Native.
  • TypeScript - Superset de JavaScript que adiciona tipagem estática ao código.
  • Zustand - Biblioteca minimalista e prática para gerenciamento de estados no React e React Native.
  • Nativewild - Usa Tailwind CSS como linguagem de script para criar um sistema de estilo universal para React Native.
  • Tailwind - Framework de estilização.

Contactos

Linkedin Badge Gmail Badge

English

📝 Table of Contents

🧐 About

Pass.in is an application for managing participants in offline events. The mobile version allows participants to issue a QR-Code credential for check-in on the day of the event. It was built during Rocketseat's "Next Level Week Unite" event, on the React Native track. The application was built using TypeScript, tailwindcss, zustand, nativewind, and other technologies.

🏁 Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

To run the application, you need to have Node.js installed on your machine. You can download Node.js here. You also need to have Git installed on your machine. You can download Git here.

Installation

To access the project, simply clone the repository or download the project files. To clone the repository, use the following command in your terminal:

https://github.com/JsExpertCoder/nlw-unite-react-native.git

After cloning the repository, access the mobile folder and install the dependencies using the following command in your terminal:

npm install

After installing the dependencies of the mobile folder, you can run the app using the following command in your terminal (being in the mobile folder):

npx expo start

After this, just make sure you have the Expo Go app installed on your physical device and scan the QR-Code that appears in the terminal. You can find the Expo Go in the app store of your smartphone here.

Then, navigate to the server folder and install the dependencies using the following command in your terminal:

npm install

After installing the dependencies of the server folder, still being in this folder, use the following command in your terminal to start the server:

npm run dev

After running the server, you can access a graphical interface to visualize the data in the database by running the following command in your terminal (in the server folder):

npx prisma studio

With that, the server will be running at http://localhost:3333, and the Prisma Studio (the graphical interface) at http://localhost:5555, to access, just access this address in your browser.

⛏️ Technologies

  • ReactJS - JavaScript library for building user interfaces.
  • React Native - A powerful framework developed by Facebook that allows developers to build mobile apps using JavaScript.
  • Expo - Tool used in mobile development with React Native.
  • TypeScript - A superset of JavaScript that adds static typing to the language.
  • Zustand - A minimalist and practical state management library for React and React Native.
  • Nativewild - Uses Tailwind CSS as a scripting language to create a universal styling system for React Native.
  • Tailwind - A utility-first CSS framework.

Contacts

Linkedin Badge Gmail Badge