Happy is a complete application built on Node.js, ReactJs and React Native

Backend Technologies  |   Backend Getting Started  |   How To Contribute  |   Backend License

Frontend Technologies |  Frontend Getting Started |  How To Contribute |  Frontend License

Mobile Technologies  |   Mobile Getting Started  |   How To Contribute  |   Mobile License

👨🏻‍💻 About the project

Happy is a project that aims to bring people together to visit children and teenagers in orphanages in order to make their days more joyful. Both on the web and on the mobile version, the institutions that house these children and adolescents can register and from there, through a map inside the platform, volunteers can choose the closest institution, or the one that is most interesting and get informed with them how to schedule a visitation and/or donation of materials that it is currently needing.

This is a project developed by me (Franciane Povoa) during #NextLevelWeek3. An online programming event offered by Rocketseat that shows how to use the JavaScript/TypeScript stack, on the backend with Nodejs, on the frontend with ReactJS and on the mobile using Expo.

---

🚀 Backend Technologies

Technologies that I used to develop this api

• Node.js
• TypeScript
• Cors
• Express
• Express-Async-Errors
• TypeORM
• Sqlite3
• Multer
• Yup
• VS Code and Prettier RC
• Insomnia
• Beekeeper Studio

💻 Backend getting started

Requirements

• Node.js
• Yarn or npm

Clone the project and access the folder

$ git clone https://github.com/francianepovoa/happy.git

$ cd happy

$ cd backend

Follow the steps below

# Install the dependencies
$ yarn

# Run the API
$ yarn dev

🤔 How to contribute backend

Follow the steps below

# Clone your fork
$ git clone https://github.com/francianepovoa/happy.git

$ cd happy

$ cd backend

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

# Make the commit with your changes
$ git commit -m 'feat: Your new feature'

# Send the code to your remote branch
$ git push origin your-feature

After your pull request is merged, you can delete your branch

📝 Backend License

This project is under the MIT license. See the LICENSE for more information.

---

🚀 Frontend Technologies

Technologies that I used to develop this frontend app

• ReactJS
• TypeScript
• Axios
• React Router v5
• React-Icons
• React-Leaflet
• React-Icons
• VS Code with ESLInt, and Prettier RC

💻 Frontend getting started

Requirements

• Node.js
• Yarn or npm

Clone the project and access the folder

$ git clone https://github.com/francianepovoa/happy.git

$ cd happy

$ cd web

Follow the steps below

# Install the dependencies
$ yarn

# Run the web app
$ yarn start

🤔 How to contribute frontend

Follow the steps below

# Clone your fork
$ git clone https://github.com/francianepovoa/happy.git

$ cd happy

$ cd web

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

# Make the commit with your changes
$ git commit -m 'feat: Your new feature'

# Send the code to your remote branch
$ git push origin your-feature

After your pull request is merged, you can delete your branch

📝 Frontend License

This project is under the MIT license. See the LICENSE for more information.

---

🚀 Mobile Technologies

Technologies that I used to develop this mobile app

• Expo
• React-Native
• Axios
• @expo-google-fonts
• @react-navigation/navigator
• React-Navigation-Stack
• React-Native-Maps
• VS Code with EditorConfig and Prettier RC

💻 Mobile getting started

Requirements

• Node.js
• Yarn or npm
• Expo

Clone the project and access the folder

$ git clone https://github.com/francianepovoa/happy.git

$ cd happy

$ cd mobile

Follow the steps below

# Install the dependencies
$ yarn

# Run the mobile app
$ yarn start

Install the app on a physical phone

1. Go to your app store, look for the app called Expo, and install it on your device.

2. With the app installed, open it and click on Scan QR Code, point the camera phone to the QR code shown on the page that opened after executing the command yarn start and ready, the app will load and be ready for use.

🤔 How to contribute mobile

Follow the steps below

# Clone your fork
$ git clone https://github.com/francianepovoa/happy.git

$ cd happy

$ cd mobile

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

# Make the commit with your changes
$ git commit -m 'feat: Your new feature'

# Send the code to your remote branch
$ git push origin your-feature

After your pull request is merged, you can delete your branch

📝 Mobile License

This project is under the MIT license. See the LICENSE for more information.

---

Made with ♥ by Franciane Póvoa 👋 Get in touch!