README-en.md

Studio Amanda Borges

English · Português

💬 Description

This is the online portfolio of architect Amanda Borges. In it you can learn a little more about her main projects, a brief description about her and how you can get in touch.

🚀 Technologies

Front-end

• NextJS - Framework (based on the ReactJS library) used to build interfaces
• Google Fonts - Library containing various fonts
• Swiper - Component for creating carousels
• Yet Another React Lightbox - Image preview component
• Tailwind CSS - CSS framework for styling
• Jest - Automated testing framework
• Testing Library - Automated Testing Library

Layout

You can view the project layout through this link.

Back-end

• DatoCMS - CMS
• API GraphQL
• Mock Service Worker - JavaScript library used to create API simulations in front-end applications. It allows you to intercept and manipulate network requests made by the browser, providing mocked responses without the need to modify the application code

🚀 Getting started

First of all you need to have node and yarn(or npm) installed on your machine.

If you decide to use npm don't forget to delete yarn.lock in folders.

Then you can clone the repository.

  git clone https://github.com/zehguilherme/studio-amanda-borges

Start the application

1. cd web
2. yarn or npm install
3. yarn dev or npm run dev

✅ Tests

Unit tests

1. cd web
2. yarn test or npm run test

🤔 How to contribute

1. Fork the project;
2. Create your feature branch: git checkout -b my-new-feature;
3. Commit your changes: git commit -m 'feat: Add some feature';
4. Push to the branch: git push origin my-new-feature;
5. Create a new Pull Request;
6. After the merge of your pull request is done, you can delete your branch.

---

Made with 💟 by José Guilherme Paro Monteiro Tomaine 👋 Talk to me!