Happy

Roadmap   |    Technologies   |    Layout   |    Project   |    How to run   |    How to contribute   |    License

Roadmap

• Day 1: Acelerando sua evolução 12/10 - ✔️
• Day 2: Olhando as oportunidades 13/10 - ✔️
• Day 3: A escolha da Stack 14/10 - ✔️
• Day 4: Até 2 anos em 2 meses 15/10 - ✔️
• Day 5: Milha extra 16/10 - ✔️

🚀 Technologies

This project was developed with the following techs:

• Node
• React
• React Native
• TypeScript

🏷️ Layout

Access project layout here

💻 Project

Happy is a project created to celebrate children's day. This application helps people to find orphanages to visit.

🏃 How to run

Backend

API Reference:

Access backend folder and install the dependencies

  $ yarn

  # or

  $ npm install

And then edit the file src/views/images_views with your current IP address:

  // your ip is required to display photos on your mobile device

  render(image: Image) {
		return {
			id: image.id,
			url: `http://YOUR_CURRENT_IP_ADDRESS:3333/uploads/${image.path}`,
		};
	},

After that run the database migrations

  $ yarn typeorm migration:run

  # or

  $ npm typeorm migration:run

Finally start the server

  $ yarn dev

  # or

  $ npm run dev

Frontend

Access web folder and install the dependencies

  $ yarn

  # or

  $ npm install

After that start the server

  $ yarn start

  # or

  $ npm run start

Mobile

Access mobile folder and install the dependencies

  $ yarn

  # or

  $ npm install

After that edit the file src/services/api.ts with your current IP address:

  const api = axios.create({
    baseURL: 'http://YOUR_CURRENT_IP_ADDRESS:3333',
  });

After all start the app

  expo start

🤔 How to contribute

• Fork this repo;
• Create a branch for your new feature: git checkout -b my-feature;
• Commit your changes: git commit -m 'feat: My brand new feature';
• Push it to your branch: git push origin my-feature.

After merge of your pull request, you can delete your branch.

📝 License

This project is under MIT license. See the file LICENSE for details.

---