Happy - Make children's day happy

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

🧸 About the project

This project was developed on the Next Level Week #03 event by Rocketseat 🚀 💜

Happy is an application that connects people to institutional care homes to make many children's day happier

🚀 Technologies

Technologies that I used to develop this application

• Node.js
• ReactJS
• React Native
• TypeScript
• Expo
• Express
• TypeORM
• Yup
• Axios
• React Router DOM
• React Navigation

💻 Getting started

Import the Insomnia.json on Insomnia App or click on Run in Insomnia button

Requirements

• Node.js
• Yarn
• Expo

$ git clone https://github.com/EliasGcf/nlw-3.git && cd nlw-3

Follow the steps below

Backend

# Starting from the project root folder, go to backend folder
$ cd backend

# Install the dependencies
$ yarn

# Use the script to run the migrations
$ yarn typeorm migration:run

# To finish, run the api service
$ yarn dev

# Well done, project is started!

Web

Obs.: Before to continue, be sure to have the API running

# Starting from the project root folder, go to web folder
$ cd web

# Install the dependencies
$ yarn

# Be sure the file 'src/services/api.ts' have the IP to your API

# Start the client
$ yarn start

Mobile

Obs.: Before to continue, be sure to have the API running

# Starting from the project root folder, go to mobile folder
$ cd mobile

# Be sure the file 'src/services/api.ts' have the IP to your API

# Start the expo service and scan the QR code with Expo Client
$ yarn start

🤔 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 EliasGcf/nlw-3

Follow the steps below

# Clone your fork
$ git clone your-fork-url && cd nlw-3

# Create a branch with your feature
$ git checkout -b my-feature

# Make the commit with your changes
$ git commit -m 'feat: 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 Elias Gabriel 👋  See my linkedin