Git Product home page Git Product logo

quizzy's Introduction

Quizzy Backend

CI

Quizzy is a backend project built on a Docker-based infrastructure for the Symfony web framework, with FrankenPHP and Caddy inside. It provides a powerful backend environment to create, manipulate, and respond to quizzes.

Features

  • Create and manage quizzes
  • Respond to quizzes
  • API documentation available at /api/doc

Getting Started

To run Quizzy, follow these steps:

  1. Environment Setup: Create a file named .env.local and set your database URL:

    DATABASE_URL="postgresql://app:[email protected]:5432/quizzy?serverVersion=16&charset=utf8"
  2. Use make start to launch the Docker environment. Database Schema: Connect to the Docker container with make sh and run the following commands:

  3. Connect to the Docker container with make sh and run the following commands:

# Create the database schema
php bin/console doctrine:migrations:migrate

# Load fixtures
php bin/console doctrine:fixtures:load

Testing Endpoints

We use Insomnia to test API endpoints. You can import the Insomnia configuration from the .insomnia folder. Here's how to import in Insomnia.

Additional Setup

For local development, you can add a TLS certificate to avoid security warnings. Refer to the Caddy TLS guide for more information.

Stopping the Project

To stop and clean up the Docker environment, use:

docker compose down --remove-orphans

License

This project is licensed under the MIT License.

Contributing

Contributions are welcome! Please create issues or submit pull requests on our GitHub repository.

Contact

If you have any questions or need support, you can reach us through our GitHub repository.

Additional Resources

  1. Build options
  2. Using Symfony Docker with an existing project
  3. Support for extra services
  4. Deploying in production
  5. Debugging with Xdebug
  6. TLS Certificates
  7. Using a Makefile
  8. Troubleshooting
  9. Updating the template

quizzy's People

Contributors

antbou avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.