diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json index 518fa1b..1d02d0b 100644 --- a/.devcontainer/devcontainer.json +++ b/.devcontainer/devcontainer.json @@ -1,5 +1,5 @@ { - "name": "Flashcard API", + "name": "Meeio Backend", "dockerComposeFile": [ "../docker-compose.yaml" ], diff --git a/.github/.env.test b/.github/.env.test index 1375c4d..e27a5b9 100644 --- a/.github/.env.test +++ b/.github/.env.test @@ -2,7 +2,7 @@ APP_ENV=test APP_SECRET=ChangeMe KERNEL_CLASS='App\Kernel' SYMFONY_DEPRECATIONS_HELPER=999999 -DATABASE_URL="postgresql://user:password@0.0.0.0:5432/flashcard?serverVersion=16.4&charset=utf8" +DATABASE_URL="postgresql://user:password@0.0.0.0:5432/meeio?serverVersion=16.4&charset=utf8" CORS_ALLOW_ORIGIN='^https?://(localhost|127\.0\.0\.1)(:[0-9]+)?$' MAILER_DSN=smtp://localhost MESSENGER_TRANSPORT_DSN=null diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 1ef8e95..99a2f72 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,5 +1,5 @@ blank_issues_enabled: true contact_links: - name: Questions & discussions - url: https://github.com/MrAnyx/Flashcard-API/discussions + url: https://github.com/meeio-app/backend/discussions about: Ask questions & discuss diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 37e0a25..47c9919 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,24 +1,19 @@ -
-
- - Logo - - -

Flashcard API

+ +

Create, manage and practice your flashcard with ease!
Explore the docs · - Submit a request + Submit a request

## Overview -The Flashcard API is a Symfony REST API designed to facilitate the creation, organization, and review of flashcards. Built with a developer-friendly approach, this API serves as the backend for a Nuxt.js application, providing users with the tools to efficiently manage their learning resources. +The Meeio API is a Symfony REST API designed to facilitate the creation, organization, and review of flashcards. Built with a developer-friendly approach, this API serves as the backend for a Nuxt.js application, providing users with the tools to efficiently manage their learning resources. ## Features @@ -29,7 +24,7 @@ The Flashcard API is a Symfony REST API designed to facilitate the creation, org ## Getting Started -To get started with the Flashcard API, follow the instructions below. +To get started with the Meeio API, follow the instructions below. ### Prerequisites @@ -44,8 +39,8 @@ Make sure you have the following installed: 1. **Clone the repository**: ```bash - git clone https://github.com/MrAnyx/Flashcard-API.git - cd Flashcard-API + git clone https://github.com/meeio-app/backend.git + cd backend ``` > [!IMPORTANT] @@ -59,7 +54,7 @@ Otherwise, you can still do the manual way. docker-compose up -d ``` -3. **prepare the project**: +3. **Prepare the project**: ```bash docker-compose exec task a:d:c @@ -71,7 +66,7 @@ Otherwise, you can still do the manual way. ## Contributing Guidelines -We welcome contributions to the Flashcard API! To maintain a high-quality codebase and collaborative environment, please follow these guidelines: +We welcome contributions to the Meeio API! To maintain a high-quality codebase and collaborative environment, please follow these guidelines: ### Code of Conduct @@ -84,7 +79,7 @@ This project adheres to a [Code of Conduct](CODE_OF_CONDUCT.md). We expect all c 2. **Clone your fork**: ```bash - git clone https://github.com/your-username/Flashcard-API.git + git clone https://github.com/your-username/backend.git ``` ### Conventional Commits @@ -173,4 +168,4 @@ We encourage open discussions about features, bugs, and improvements. Please be ## License -Distributed under the AGPL-3.0 License. See [License](https://github.com/MrAnyx/Flashcard-API/blob/master/LICENSE) for more information. +Distributed under the AGPL-3.0 License. See [License](https://github.com/meeio-app/backend/blob/master/LICENSE) for more information. diff --git a/README.md b/README.md index b6c02b3..b0ef578 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ - +

@@ -6,17 +6,17 @@
Explore the docs · - Submit a request + Submit a request

- GitHub Tag - GitHub Repo stars - GitHub contributors - GitHub Issues or Pull Requests - GitHub License + GitHub Tag + GitHub Repo stars + GitHub contributors + GitHub Issues or Pull Requests + GitHub License

@@ -27,12 +27,12 @@ ## About The Project - - - + + + -This project is the [Symfony backend REST API](https://github.com/MrAnyx/Flashcard-API) for a [flashcard](https://en.wikipedia.org/wiki/Flashcard) platform. +This project is the [Symfony backend REST API](https://github.com/meeio-app/backend) for a [flashcard](https://en.wikipedia.org/wiki/Flashcard) platform. I started this project because I couldn’t find a flashcard app that combined both a modern, visually appealing interface and effective functionality. @@ -52,49 +52,10 @@ This project is entirely built using [Symfony](https://symfony.com/) and its eco Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**. -If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". +If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue. Don't forget to give the project a star! Thanks again! -1. **Fork the repository** - - Start by forking the project repository on GitHub. This creates a copy of the project in your account where you can freely make changes. - -2. **Clone the repository** - - ```bash - git clone https://github.com//Flashcard-API.git - ``` - -3. **Create a new branch** - - Use a descriptive branch name that reflects the purpose of your changes. For example: - - ```bash - git checkout -b feature/new-feature - ``` - -4. **Make changes** - - Implement your changes. Make sure to follow coding standards and write clear, maintainable code. Add tests where appropriate, especially if your changes affect core functionality. - -5. **Test your changes** - - Ensure that your changes don’t break existing functionality by running the test suite: - - ```bash - # Unit tests - ./vendor/bin/pest - - # Static tests - vendor/bin/phpstan analyse -c phpstan.neon --memory-limit 500M --ansi --error-format=table - - # Code style - ./vendor/bin/php-cs-fixer fix --dry-run - ``` - -6. **Sync your changes** - - Write clear and concise commit messages that describe what you’ve done. It must follow the [Conventional Commit](https://www.conventionalcommits.org/) standard. Then, push your changes and open a pull request. +Please, refer to the [CONTRIBUTING](https://github.com/meeio-app/backend/blob/master/CONTRIBUTING.md) markdown file for more details. ## Code of Conduct @@ -102,17 +63,17 @@ Please respect other contributors and maintainers by following our Code of Condu ## Need Help? -If you’re new to open-source contribution or have questions, feel free to open an [issue](https://github.com/MrAnyx/Flashcard-API/issues/new/choose) or open a [discussion thread](https://github.com/MrAnyx/Flashcard-API/discussions). We’re happy to guide you through your first contribution! +If you’re new to open-source contribution or have questions, feel free to open an [issue](https://github.com/meeio-app/backend/issues/new/choose) or open a [discussion thread](https://github.com/meeio-app/backend/discussions). We’re happy to guide you through your first contribution! ## Top contributors: - - contrib.rocks image + + contrib.rocks image ## License -Distributed under the AGPL-3.0 License. See [License](https://github.com/MrAnyx/Flashcard-API/blob/master/LICENSE) for more information. +Distributed under the AGPL-3.0 License. See [License](https://github.com/meeio-app/backend/blob/master/LICENSE) for more information. ## Acknowledgments diff --git a/assets/dark.png b/assets/dark.png index eca592b..b74234f 100644 Binary files a/assets/dark.png and b/assets/dark.png differ diff --git a/assets/light.png b/assets/light.png index ef223b9..4673e57 100644 Binary files a/assets/light.png and b/assets/light.png differ diff --git a/composer.json b/composer.json index 4cd55ac..c19b66d 100644 --- a/composer.json +++ b/composer.json @@ -1,6 +1,6 @@ { "name": "meeio/backend", - "description": "Flashcard API backend", + "description": "Backend REST API using Symfony for a Meeio", "type": "project", "license": "proprietary", "minimum-stability": "stable",