Geoffrey65 / Flatacuties

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Flatacuties

This is a web app that allows users to vote for the cutest animals.It he;ps users to view of animal names ,seeing the details of each animal and also to vote for their favorites.

setting up the Project

You need to set up and start local the server

  1. Create a db.json file in your project directory with the sample data.
  2. Start the JSON DB server by running the following command(json-server --watch db.json)
  3. Test your server by visiting http://localhost:3000/characters in your browser.
  4. You should see the character data.
  5. Clone the repository to your local machine.

How to run

  1. Create a new branch for your work
  2. Implement your changes.
  3. Test your changes and ensure they work correctly.

Usage

  1. Viewing animal details
  2. Showing the list of animal names
  3. voting for animals

Features

  1. Displaying the list of animal names.
  2. Viewing details for information about each animal.
  3. Voting for your favorite animal.
  4. Reseting votes to 0 (bonus feature).Development
  • To work on this project, follow these steps:

Development

  1. Clone the repository to your local machine.
  2. Create a new branch for your work.
  3. Implement your changes.
  4. Test your changes and ensure they work correctly.
  5. Commit your changes with descriptive commit message.
  6. Push your branch to the repository
  7. Create a pull request to merge your changes into the main branch.

Contirbuting

If you could want to contribute to this project follow the development steps above

to and submit a pull request.

License

MIT License

Copyright (c) 2023 gnyanyuki503

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

About

License:MIT License


Languages

Language:JavaScript 76.4%Language:HTML 12.0%Language:CSS 11.6%