GiftWish is a Symfony-based web application designed to manage wishlists, gifts, and invitations for collaborative gift exchanges. This website was developped as part of the WEBAPP UE at IMT Atlantique.
## Features
## Getting started
- User registration and authentication.
- Create, edit, and share wishlists.
- Add items to wishlists with details like name, description, price, and URL.
- Upload proof of purchased gifts.
- Collaborate with other users or simply shere with them a wishlist.
- Admin dashboard for managing users and viewing statistics.
To make it easy for you to get started with GitLab, here's a list of recommended next steps.
## Installation
Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!
## Add your files
-[ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files
-[ ] [Add files using the command line](https://docs.gitlab.com/topics/git/add_files/#add-files-to-a-git-repository) or push an existing Git repository with the following command:
-[ ] [Set up project integrations](https://gitlab-df.imt-atlantique.fr/j22yao/ue_webapp_projet_equipe_05/-/settings/integrations)
## Collaborate with your team
-[ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/)
-[ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
-[ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
Use the built-in continuous integration in GitLab.
-[ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/)
-[ ] [Analyze your code for known vulnerabilities with Static Application Security Testing (SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)
-[ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
-[ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)
-[ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)
***
# Editing this README
When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thanks to [makeareadme.com](https://www.makeareadme.com/) for this template.
Follow these steps to set up the project locally:
1. Clone the repository:
```bash
git clone <repository-url>
cd tp-symfony/projetUEG
```
2. Install dependencies:
```bash
composer install
npm install
```
3. Set up environment variables:
- Copy `.env` to `.env.local` and configure database credentials:
The username and password used in the project are:
- username: root
- password: root_PWD-iaw
4. Install front-end assets:
```bash
npm run build
```
5. Start the Symfony server:
```bash
symfony server:start
```
## Database Migration and Setup
To set up the database and apply migrations for the `app.sql` database:
1. Create the database:
```bash
php bin/console doctrine:database:create
```
2. Import the app.sql file:
```bash
mysql -u root -p app < app.sql
```
3. Verify the databse:
Check that the tables and data have been imported correctly by logging into your database:
```bash
mysql -u username -p app
```
## Suggestions for a good README
## Usage
Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
- Access the application at `http://127.0.0.1:8000`.
- Register or log in to start creating and managing wishlists.
- Admin users can access the dashboard at `/admin`.
## Name
### Sharing a wishlist
Choose a self-explaining name for your project.
To share a wishlist with other users, you can specify their usernames when creating the wishlist or editing t.
## Description
### Admin account
Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
To log in with the admin account, use the following credentials:
- username: admin@gmail.com
- password: admin2025
## Badges
## Technologies Used
On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
## Visuals
Frontend: HTML, CSS, JavaScript (specific framework to be specified)
Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
## Installation
Backend: Chosen language and framework (e.g., Node.js, PHP, or others)
Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
## Usage
Database: Management system (MySQL, PostgreSQL, etc.)
Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
## Support
Modeling Tools: UML software for design
Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
## Roadmap
Development Environment: Docker for container management and orchestration (mentioned in encountered issues)
If you have ideas for releases in the future, it is a good idea to list them in the README.
## Contributing
## Contributing
State if you are open to contributions and what your requirements are for accepting them.
For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
Contributions are welcome! Please follow these steps:
## Authors and acknowledgment
1. Fork the repository.
Show your appreciation to those who have contributed to the project.
2. Create a new branch for your feature or bugfix.
3. Commit your changes and push to your fork.
4. Submit a pull request.
## License
## License
For open source projects, say how it is licensed.
## Project status
This project is licensed under the MIT License. See the `LICENSE` file for details.
If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.
