Skip to content

A simple API that serves motivational and programming quotes from a JSON file. Perfect for beginners to contribute during Hacktoberfest — just add new quotes or endpoints!

License

Notifications You must be signed in to change notification settings

egeDevelops/Quoteverse

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

12 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

🌟 QuoteVerse

A simple full-stack app: a Spring Boot REST API backend and a React frontend that serves motivational and programming quotes from a JSON file.

🚀 Features

  • Browse all quotes
  • Get a random quote
  • Add quotes by editing a JSON file (no database required)
  • Beginner-friendly contribution flow for Hacktoberfest 🎉

🛠️ Backend Setup (Spring Boot)

  1. Fork the repository:

    • Click the "Fork" button on the top right corner of the repository page on GitHub.
  2. Clone your forked repository:

    git clone https://github.com/<your-username>/QuoteVerse.git
    cd QuoteVerse
  3. Open the project in your favorite IDE (e.g., IntelliJ IDEA).

  4. Build the project using Maven:

    mvn clean install
  5. Run the Spring Boot application:

    mvn spring-boot:run
  6. The backend will be available at http://localhost:8080.

🌐 Frontend Setup (React)

  1. Navigate to the frontend directory:

    cd frontend
  2. Install dependencies:

    npm install
  3. Start the React development server:

    npm start
  4. The frontend will be available at http://localhost:3000.

🎃 Hacktoberfest Contributions

We welcome contributions from developers of all skill levels! Follow these steps to contribute:

  1. Fork the repository:

    • Click the "Fork" button on the top right corner of the repository page on GitHub.
  2. Clone your forked repository:

    git clone https://github.com/<your-username>/QuoteVerse.git
  3. Create a new branch for your feature or bug fix:

    git checkout -b <branch-name>
  4. Make your changes and commit them:

    git add .
    git commit -m "Your descriptive commit message"
  5. Push your branch to your forked repository:

    git push origin <branch-name>
  6. Create a pull request:

    • Go to the original repository on GitHub.
    • Click the "New Pull Request" button and select your branch.

Check out the CONTRIBUTING.md file for more details.

📂 Project Structure

QuoteVerse/
├── backend/       # Spring Boot backend
├── frontend/      # React frontend
├── quotes.json    # JSON file containing quotes
└── README.md      # Project documentation

⭐ Star and Fork

If you like this project, please consider giving it a ⭐ on GitHub and forking the repository to contribute or use it as a template for your own projects.

📜 License

This project is licensed under the MIT License. See the LICENSE file for details.

About

A simple API that serves motivational and programming quotes from a JSON file. Perfect for beginners to contribute during Hacktoberfest — just add new quotes or endpoints!

Resources

License

Code of conduct

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 82.8%
  • Java 10.1%
  • HTML 6.7%
  • CSS 0.4%