Skip to content

Commit

Permalink
refactor(core) Update project references from Flashcard to Meeio
Browse files Browse the repository at this point in the history
  • Loading branch information
MrAnyx committed Jan 1, 2025
1 parent b3c6f13 commit aac1c4c
Show file tree
Hide file tree
Showing 8 changed files with 32 additions and 76 deletions.
2 changes: 1 addition & 1 deletion .devcontainer/devcontainer.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "Flashcard API",
"name": "Meeio Backend",
"dockerComposeFile": [
"../docker-compose.yaml"
],
Expand Down
2 changes: 1 addition & 1 deletion .github/.env.test
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -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
27 changes: 11 additions & 16 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,19 @@
<br />
<div align="center">
<a href="https://github.com/MrAnyx/Flashcard-API">
<img src="https://raw.githubusercontent.com/MrAnyx/Flashcard-App/refs/heads/master/assets/images/logo.png" alt="Logo" width="50" height="50">
</a>

<h3 align="center">Flashcard API</h3>
<img src="https://raw.githubusercontent.com/meeio-app/backend/refs/heads/master/assets/banner.png">

<div align="center">
<p align="center">
Create, manage and practice your flashcard with ease!
<br />
<a href="#">Explore the docs</a>
·
<a href="https://github.com/MrAnyx/Flashcard-API/issues/new/choose">Submit a request</a>
<a href="https://github.com/meeio-app/backend/issues/new/choose">Submit a request</a>
<br />
</p>
</div>

## 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

Expand All @@ -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

Expand All @@ -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]
Expand All @@ -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
Expand All @@ -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

Expand All @@ -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
Expand Down Expand Up @@ -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.
73 changes: 17 additions & 56 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,22 @@
<img src="https://raw.githubusercontent.com/MrAnyx/Flashcard-API/refs/heads/master/assets/banner.png">
<img src="https://raw.githubusercontent.com/meeio-app/backend/refs/heads/master/assets/banner.png">

<div align="center">
<p align="center">
Create, manage and practice your flashcard with ease!
<br />
<a href="#">Explore the docs</a>
·
<a href="https://github.com/MrAnyx/Flashcard-API/issues/new/choose">Submit a request</a>
<a href="https://github.com/meeio-app/backend/issues/new/choose">Submit a request</a>
<br />
</p>
</div>

<div align="center">
<a href="https://github.com/MrAnyx/Flashcard-API/tags"><img alt="GitHub Tag" src="https://img.shields.io/github/v/tag/MrAnyx/Flashcard-API?style=flat&colorB=38BDF8"></a>
<a href="https://github.com/MrAnyx/Flashcard-API/stargazers"><img alt="GitHub Repo stars" src="https://img.shields.io/github/stars/MrAnyx/Flashcard-API?style=flat&colorB=38BDF8"></a>
<a href="https://github.com/MrAnyx/Flashcard-API/graphs/contributors"><img alt="GitHub contributors" src="https://img.shields.io/github/contributors/MrAnyx/Flashcard-API?style=flat&colorB=38BDF8"></a>
<a href="https://github.com/MrAnyx/Flashcard-API/issues"><img alt="GitHub Issues or Pull Requests" src="https://img.shields.io/github/issues-raw/MrAnyx/Flashcard-API?style=flat&colorB=38BDF8"></a>
<a href="https://github.com/MrAnyx/Flashcard-API/blob/master/LICENSE"><img alt="GitHub License" src="https://img.shields.io/github/license/MrAnyx/Flashcard-API?style=flat&colorB=38BDF8"></a>
<a href="https://github.com/meeio-app/backend/tags"><img alt="GitHub Tag" src="https://img.shields.io/github/v/tag/meeio-app/backend?style=flat&colorB=38BDF8"></a>
<a href="https://github.com/meeio-app/backend/stargazers"><img alt="GitHub Repo stars" src="https://img.shields.io/github/stars/meeio-app/backend?style=flat&colorB=38BDF8"></a>
<a href="https://github.com/meeio-app/backend/graphs/contributors"><img alt="GitHub contributors" src="https://img.shields.io/github/contributors/meeio-app/backend?style=flat&colorB=38BDF8"></a>
<a href="https://github.com/meeio-app/backend/issues"><img alt="GitHub Issues or Pull Requests" src="https://img.shields.io/github/issues-raw/meeio-app/backend?style=flat&colorB=38BDF8"></a>
<a href="https://github.com/meeio-app/backend/blob/master/LICENSE"><img alt="GitHub License" src="https://img.shields.io/github/license/meeio-app/backend?style=flat&colorB=38BDF8"></a>
</div>

<br />
Expand All @@ -27,12 +27,12 @@
## About The Project

<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/MrAnyx/Flashcard-API/refs/heads/master/assets/dark.png">
<source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/MrAnyx/Flashcard-API/refs/heads/master/assets/light.png">
<img src="https://raw.githubusercontent.com/MrAnyx/Flashcard-API/refs/heads/master/assets/dark.png">
<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/meeio-app/backend/refs/heads/master/assets/dark.png">
<source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/meeio-app/backend/refs/heads/master/assets/light.png">
<img src="https://raw.githubusercontent.com/meeio-app/backend/refs/heads/master/assets/dark.png">
</picture>

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.

Expand All @@ -52,67 +52,28 @@ 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/<your-username>/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

Please respect other contributors and maintainers by following our Code of Conduct. Contributions should align with the values of inclusivity, transparency, and respect for everyone involved in the project.

## 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:

<a href="https://github.com/MrAnyx/Flashcard-API/graphs/contributors">
<img src="https://contrib.rocks/image?repo=MrAnyx/Flashcard-API" alt="contrib.rocks image" />
<a href="https://github.com/meeio-app/backend/graphs/contributors">
<img src="https://contrib.rocks/image?repo=meeio-app/backend" alt="contrib.rocks image" />
</a>

## 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

Expand Down
Binary file modified assets/dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/light.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion composer.json
Original file line number Diff line number Diff line change
@@ -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",
Expand Down

0 comments on commit aac1c4c

Please sign in to comment.