https://github.com/fishglitch/online-library-vite-react
https://github.com/fishglitch/online-library-vite-react
Last synced: 7 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/fishglitch/online-library-vite-react
- Owner: fishglitch
- Created: 2025-02-05T04:57:17.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-15T23:38:36.000Z (about 1 year ago)
- Last Synced: 2025-04-08T14:54:28.009Z (about 1 year ago)
- Language: JavaScript
- Size: 14 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Reading is Revolutionary Online Library
## Description: Working out of a starter code with a built-in API, this online public library's front end is developed to ensure on-time delivery to the client. As of 3/15/25: to be deployed.
## Table of Contents
- [Installation](#installation)
- [Usage](#usage)
- [API Documentation](#api-documentation)
- [Branches](#branches)
- [How to Switch Branches](#switch-branches)
- [Roadmap of Features](#roadmap-of-features)
- [Contributing and Contact Info](#contributing-and-contact-info)
- [Acknowledgements](#acknowledgements)
- [](#)
## Installation
1. Clone repo
2. Nav to project directory
3. Install dependencies: 'npm install vite --save-dev'
## Usage
To start the development server, run:
```bash
npm run dev
Then open your browser and navigate to http://localhost:3000
CTRL + C to quit
```
## API Documentation
🔗 [here](https://fsa-book-buddy-b6e748d1380d.herokuapp.com/docs/)
## Branches
This repository contains two primary branches:
### `main`
- **Purpose**: This branch represents the stable production-ready version of the application. Changes that have been thoroughly tested and are ready for deployment are merged into this branch.
- **Usage**: Use this branch if you want to run or deploy the application in a production environment.
### `development`
- **Purpose**: This branch serves as the development branch where new features, bug fixes, and other changes are integrated and tested before they are merged into the `main` branch.
- **Usage**: You can check out this branch to explore the latest features, contribute code, or help with testing.
## How to Switch Branches
To switch between branches, use the following Git commands:
```bash
# To switch to the development branch
git checkout development
# To switch back to the main branch
git checkout main
1. Main branch has clean code
2. console.log branch has console.logs and other notes.
```
## Roadmap of Features
1. 2/20/25: changed path /:id to books/:id
2. TBD: configure search functionality so that the bar does not show up on other path views, if pressed "enter", the search results come up onto another route.
## Contributing and Contact Info
If you have any questions or suggestions, or have submitted pull requests, feel free to reach out to me:
- GitHub: [fishglitch](https://github.com/fishglitch)
## Acknowledgements
Thank you Grace Hopper Program!