viniciusbavosa/Portraits

A simple website serving as a gallery for my personal photos.

Portraits

This is the Frontend of a FullStack application that communicates with its own API. Developed with React, Typescript, Framer Motion and Styled-components.

This website was developed to serve as a personal gallery. It features a authentication-protected route that allows uploading new photos from a local machine directly to the website through its API and an Nodejs automation script.

Content

• Installation
• How to use
• License
• Credits

How to use

1. Clone repo:

   • git clone https://github.com/viniciusbavosa/Portraits

2. Install dependencies with pnpm

   • pnpm install

3. Set environment variables

   • Use .env-example in the repository root as an example
   • Create a .env file with the environment variables from .env-example

4. Start application with pnpm -> pnpm run dev

5. Application will run on -> http://localhost:5173/

   • In case another port has been set, just change 5173 to the respective port;

License

This repository is licensed under the Creative Commons Attribution-NonCommercial 4.0 International Public License. Be sure to read and agree to the license terms before using its content.

Credits

Thanks to João Genari for his help during the development of this project and for providing the template for this README.