Skip to content

Commit

Permalink
Modified the readme
Browse files Browse the repository at this point in the history
  • Loading branch information
eperezme authored Dec 20, 2023
1 parent 4e12724 commit 4f16a22
Showing 1 changed file with 37 additions and 2 deletions.
39 changes: 37 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,40 @@
Welcome to my portfolio repository! This repository showcases my projects, skills, and achievements as a software developer.


View it on:
## https://eperezme.github.io/

### [Go to portfolio](https://eperezme.com)


## Project Structure

The project has the following structure:

- `src/`: This is where the main application code is located.
- `App.jsx`: This is the main React component for the application.
- `main.jsx`: This is the entry point for the application.
- `assets/`: This directory contains various assets used in the project, such as SVGs and CSS files.
- `functions/`: This directory contains various utility functions used throughout the project.
- `public/`: This directory contains public assets that are served directly by the server.
- `.github/workflows/`: This directory contains GitHub Actions workflows for deploying the application.
- `vite.config.js`: This is the configuration file for Vite, which is used for building and serving the application.

## Getting Started

To get started with development:

1. Clone the repository.
2. Run `npm install` to install dependencies.
3. Run `npm start` to start the development server.

## Deployment

This project is deployed using GitHub Actions. See the workflows in `.github/workflows/` for more details.

## Contributing

Contributions are welcome! Please open an issue or submit a pull request.

## License

This project is licensed under the MIT License.

0 comments on commit 4f16a22

Please sign in to comment.