Quotator is a web application designed to provide users with random quotes while allowing them to save their favorites, remove them if needed, and share quotes with others. Users can also filter quotes by selecting from a set list of categories.
- Get a random quote from one of the available categories.
- Add or remove quote from favorite quotess
- View favourite quotes on a dedicated page.
- Share quotes via social platforms or direct links.
- Locally store favourite quotes for persistance between sessions.
- Open the application in your web browser.
- Select desired category from drop-down menu.
- Click "Get Another Quote" button to get a new random quote.
- Click the empty star icon to save a quote to your favorites.
- Click star button in the navigation menu to visit the "Favorites" section and view saved quotes.
- Use the share button to send a quote via social media or copy its link.
- Click the full star icon to remove a quote from your list.
Make sure you have the following installed on your local development machine:
- Node.js (v18 or higher)
Older versions will probably work but are not officially supported.
-
Clone the repository:
git clone https://github.com/nsk4/Quotator.git cd Quotator -
Install dependencies:
npm install
To run the application in development mode:
npx vite --port=4000This will start the Vite development server. Open your browser and navigate to http://localhost:4000.
This project includes a devcontainer configuration to set up a consistent development environment using Visual Studio Code Dev Containers. You can read more about devcontainers HERE.
- Docker installed on your machine.
- Visual Studio Code installed.
- Remote - Containers extension installed in Visual Studio Code.
-
Clone the repository:
git clone https://github.com/nsk4/Quotator.git cd Quotator -
Open the project in Visual Studio Code.
-
If prompted, reopen the project in a container by clicking on the green "Open a Remote Window" button in the bottom left corner of the window, then select "Reopen in Container."
-
Visual Studio Code will now build the devcontainer image and start the container with the necessary dependencies for development.
-
Install dependencies:
npm install
-
You are now ready to start developing inside the devcontainer.
If you encounter any bugs or issues, please report them by creating a new issue in the GitHub Issues section of the repository. Provide as much detail as possible, including steps to reproduce the issue, your environment, and any relevant screenshots or logs.
Contributions are welcome! Please follow these steps:
- Fork the repository.
- Create your feature branch: git checkout -b feature/your-feature-name.
- Commit your changes: git commit -m 'Add some feature'.
- Push to the branch: git push origin feature/your-feature-name.
- Open a pull request.
Please ensure your code adheres to the project's coding standards and passes all tests.
This project is licensed under the MIT License. See the LICENSE file for more details.