Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/stefanosaffran/happy
Happy - Developed during the event NLW 3.0 by @Rocketseat
https://github.com/stefanosaffran/happy
axios expo express leaflet nextlevelweek nodejs orphanages react-icons react-native react-navigation reactjs rocketseat sqlite3 typeorm typescript yup
Last synced: 20 days ago
JSON representation
Happy - Developed during the event NLW 3.0 by @Rocketseat
- Host: GitHub
- URL: https://github.com/stefanosaffran/happy
- Owner: StefanoSaffran
- License: mit
- Created: 2020-10-11T20:54:37.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2023-12-15T05:24:09.000Z (about 1 year ago)
- Last Synced: 2024-11-23T00:10:51.887Z (3 months ago)
- Topics: axios, expo, express, leaflet, nextlevelweek, nodejs, orphanages, react-icons, react-native, react-navigation, reactjs, rocketseat, sqlite3, typeorm, typescript, yup
- Language: TypeScript
- Homepage:
- Size: 655 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
📚 NextLevelWeek 3.0 📚
Project |
Built with |
How to run |
Layout |
License |
Get in touch
## :computer: Project
Happy is an application that aims helping to bring together people and orphanages to make many children's day happier.
## :rocket: Built with
This project was developed with the following technologies:
Server
- [Node.js](https://nodejs.org/)
- [Express](https://expressjs.com/)
- [Typescript](https://www.typescriptlang.org/)
- [TypeORM](https://typeorm.io/)
- [SQLite](https://www.sqlite.org/index.html)
- [TS-Node-Dev](https://www.npmjs.com/package/ts-node-dev)
- [Cors](https://www.npmjs.com/package/cors)
- [Yup](https://github.com/jquense/yup)
- [VS Code](https://code.visualstudio.com/)
Web
- [React](https://pt-br.reactjs.org/)
- [Typescript](https://www.typescriptlang.org/)
- [Axios](https://www.npmjs.com/package/axios)
- [React Icons](https://react-icons.netlify.com/#/)
- [Yup](https://github.com/jquense/yup)
- [Leaflet](https://leafletjs.com/)
- [React Leaflet](https://react-leaflet.js.org/)
- [VS Code](https://code.visualstudio.com/)
Mobile
- [React](https://pt-br.reactjs.org/)
- [React Native](https://reactnative.dev/)
- [Expo](https://expo.io/learn)
- [Typescript](https://www.typescriptlang.org/)
- [React Navigation](https://reactnavigation.org/)
- [Axios](https://www.npmjs.com/package/axios)
- [Expo Google Fonts](https://github.com/expo/google-fonts)
- [React Native Maps](https://github.com/react-native-maps/react-native-maps)
- [VS Code](https://code.visualstudio.com/)
## :information_source: How to run
### Requirements
To run the application you will need:
* [Git](https://git-scm.com)
* [Node](https://nodejs.org/)
* [Yarn](https://yarnpkg.com/)
### Backend
Now clone the repository and install the dependencies.
```bash
# to clone the repository
$ git clone https://github.com/StefanoSaffran/happy.git
# go into the server folder
$ cd happy/server
#install the backend dependencies
$ yarn
```
```bash
# run migrations
$ yarn typeorm migration:run
# run api
$ yarn dev:server
```
### Frontend
```bash
# in another tab of the terminal install the web dependencies and run it
$ cd web
$ yarn
$ yarn start
```
### Mobile
The Application was developed using Expo. It is a free and open source toolchain built around React Native to facilitate the process of running and testing applications. [Click here](https://expo.io/learn) to get start with Expo.
```bash
# install the dependencies
cd mobile
yarn
```
In order to run the application on your device, you need to change the ip config.
[api.ts](https://github.com/StefanoSaffran/happy/blob/master/mobile/src/services/api.ts)
```javascript
baseURL: 'http://192.168.1.5:3333',
```
replace 192.168.1.5 with your machine's ip.
Now with everything on place, run the application.
```bash
# to run the app
yarn start
```
Expo will open a page in your browser, scan the QRcode on the page and wait for the app to load.
> The Application was developed and tested on Android Studio Emulator.
## 🔖 Layout
In the links below you will find the layout of the web and mobile project. You need to have an account at [Figma] (http://figma.com/) to access it.
- [Layout Web](https://www.figma.com/file/mDEbnoojksG4w8sOxmudh3/Happy-Web)
- [Layout Mobile](https://www.figma.com/file/X27FfVxAgy9f5IFa7ONlph/Happy-Mobile)
## :memo: License
This project is under the MIT license. See the [LICENSE](https://github.com/StefanoSaffran/happy/blob/master/LICENSE) for more information
## :mailbox_with_mail: Get in touch!
---
Made with :coffee: and ❤️ by Stefano Saffran.