README.md

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

💛 About the project 💙

📚 BookSwap is a mobile application with the goal of helping readers of all ages to exchange books. The application has a proposal to break the cycle of buying a book, reading it and simply storing it on the shelf. Using BookSwap, readers buy a book, read the book and exchange with any other interested reader.

👩🏻‍💻👩🏼‍💻 Technologies

Technologies that we used to develop this project:

• JavaScript
• React Native
• Expo
• Node.js
• Sequelize
• Express
• MySQL

⌨ Getting started

Running the backend:

• Inside the backend folder, run npm i or yarn to install the dependencies
• Alter config/database.js, adding the setup of your MySQL database
• Run npx sequelize db:create or yarn sequelize db:create to create the database
• Run the migrations with npx sequelize db:migrate or yarn sequelize db:migrate
• Finally, run the server with npm run dev or yarn dev

Running the frontend:

• Inside the frontend folder, run npm i or yarn to install the dependencies
• Run with expo start

🖥 Preview

📖

🤔 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/bookswap

Follow the steps below

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

# 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 and Carla Ponciano