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

📝 About the project

HomeCare is an application with the goal of helping families to find caregivers specialized in helping patients, such as children and elders, on day-to-day life.

⚙ Available Languages

pt-BR: ✅ Available
EN: 💬 In Progress

👩🏻‍💻 Technologies

Technologies used to develop this project:

• Next.js
• React
• React Native
• Expo
• TypeScript
• Styled Components
• Node.js
• Knex
• SQLite
• NestJS (partially - only experimental)

🖥 Preview

homecare-1.mp4

homecare-2.mp4

⌨ Getting started

Running the backend:

• Inside the backend folder, run npm i or yarn to install the dependencies
• Run npm run knex:migrate or yarn knex:migrate to run the migrations
• Run npm run knex seed:run or yarn knex seed:run to populate the databases
• Run the server with npm start or yarn start

Running the backend-nestjs (partial project - only experimental):

• Inside the backend folder, run npm i or yarn to install the dependencies
• Change ormconfig.json, adding the setup of your MySQL database
• Build with npm run build or yarn build
• Run the server with npm start or yarn start

Running the frontend (mobile):

• Inside the frontend folder, run npm i or yarn to install the dependencies
• Run with expo 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 amanda-santos/homecare

Follow the steps below

# Clone your fork
$ git clone your-fork-url && cd homecare

# 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 Amanda Santos