Project Showcase Application - Client
This is the client-side code for the Project Showcase Application. It is built using React + Vite and communicates with a Ruby on Rails server-side API to provide the user with the functionality to add and showcase their projects.
Feel free to visit the deployed application if you'd like to create a profile and showcase your own projects.
Getting Started
To get started with the project, follow these steps:
Clone the repository:
git clone git@github.com:DakotaLMartinez/project-showcase.git
Navigate your terminal into the project directory:
cd project-showcase
Install the dependencies:
yarn install
And start the dev server:
yarn dev
The application should now be running at: http://localhost:5173.
If you are planning to deploy this on your own, you'll want to replace the url in the .env.production file with your own URL.
VITE_API_URL=https://your-deployed.url
You'll also need to clone and setup the backend API.
Contributing
If you'd like to contribute to the project, please follow these steps:
- Fork the repository
- Create a new branch for your feature or bug fix:
git checkout -b feature/my-new-feature - Make changes to the codebase
- Commit your changes:
git commit -am 'Add some feature' - Push to the branch:
git push origin feature/my-new-feature - Create a new Pull Request
Also, feel free to create an issue on GitHub to add information about a bug or feature request.
License
This project is licensed under the MIT License. See the LICENSE.md file for details.
Contact
If you have any questions about the project or would like to get in touch, please email me at dakotaleewebdev@gmail.com.
© Dakota Lee Martinez 2023