brunobussreal/nlw3-happy

Ophanages finder app, made during NLW event 3rd editon

Technologies   |    Project   |    Layout   |    License

🚀 Technologies

This project was developed with the following technologies:

• Node.js
• React
• React Native
• Expo
• TypeScript

💻 Project

Happy is an app that connects people to institutional daycare centers to make many children's day happier 💜

🔖 Layout

• Layout Web
• Layout Mobile

ℹ️ How To Use

To clone and run this application, you'll need Git, Node.js + Yarn installed on your machine.

From your command line:

# Clone this repository
$ git clone https://github.com/brunobussReal/nlw3-happy

Install API

# Go into the repository from base directory
$ cd nlw3-happy/backend

# Install dependencies
$ yarn install

# Run Migrates
$ yarn typeorm migration:run

# Start server
$ yarn dev

# running on port 3333

Install Front-end

# Go into the repository from base directory
$ cd nlw3-happy/web

# Install dependencies
$ yarn install

# Run
$ yarn start

# running on port 3000

Install Mobile

In order to run mobile version in your phone, you need to install expo first. You can find it on Google Play or App Store, or you can simply run it on emulator.

# Go into the repository from base directory
$ cd nlw3-happy/mobile

# Install dependencies
$ yarn install

# Run
$ yarn start

# Expo page will open up, you scan the qrcode on terminal or expo page with your phone.

🧠 Next steps

• Restricted access using bcrypt
• Password recovery
• Orphanage registration
• Spash screen on React Native
• User Onboarding
• Actual user location
• Multi-stage registration
• App Logout
• App Deploy

📝 License

Esse projeto está sob a licença MIT. Veja o arquivo LICENSE para mais detalhes.