Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/eliasgcf/happy
Full Application was developed on Next Level Week #3 event by @Rocketseat
https://github.com/eliasgcf/happy
Last synced: 16 days ago
JSON representation
Full Application was developed on Next Level Week #3 event by @Rocketseat
- Host: GitHub
- URL: https://github.com/eliasgcf/happy
- Owner: EliasGcf
- License: mit
- Created: 2020-10-12T01:08:26.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2020-10-17T19:58:44.000Z (about 4 years ago)
- Last Synced: 2024-10-03T12:39:39.848Z (about 1 month ago)
- Language: TypeScript
- Homepage:
- Size: 750 KB
- Stars: 33
- Watchers: 2
- Forks: 15
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
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](https://rocketseat.com.br/) 🚀 💜
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](https://nodejs.org/en/)
- [ReactJS](https://reactjs.org/)
- [React Native](https://reactnative.dev/)
- [TypeScript](https://www.typescriptlang.org/)
- [Expo](https://expo.io/)
- [Express](https://expressjs.com/pt-br/)
- [TypeORM](https://typeorm.io/#/)
- [Yup](https://github.com/jquense/yup)
- [Axios](https://github.com/axios/axios)
- [React Router DOM](https://reacttraining.com/react-router/)
- [React Navigation](https://reactnavigation.org/)
## 💻 Getting started
Import the `Insomnia.json` on Insomnia App or click on [Run in Insomnia](#insomniaButton) button
### Requirements
- [Node.js](https://nodejs.org/en/)
- [Yarn](https://classic.yarnpkg.com/)
- [Expo](https://expo.io/)
```bash
$ git clone https://github.com/EliasGcf/nlw-3.git && cd nlw-3
```
**Follow the steps below**
### Backend
```bash
# 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_
```bash
# 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_
```bash
# 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**
```bash
# 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**
```bash
# 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](LICENSE) file for details.
---
Made with 💜 by Elias Gabriel 👋 [See my linkedin](https://www.linkedin.com/in/eliasgcf/)