V-Beta-1.0.0
Vision is out of alpha !
This commit is contained in:
Xbird
245
README.md
245
README.md
@@ -1,92 +1,185 @@
|
||||
|
||||
# Vision
|
||||
|
||||
[](https://gitlab.com/gamexperience/vision-dev/-/commits/master)
|
||||
|
||||
This is a web panel to allow roleplay server to have an common interface for all publics services
|
||||
|
||||
## Getting started
|
||||
## Requirements
|
||||
|
||||
To make it easy for you to get started with GitLab, here's a list of recommended next steps.
|
||||
|
||||
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/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command:
|
||||
|
||||
```
|
||||
cd existing_repo
|
||||
git remote add origin https://gitlab.com/gamexperience/vision.git
|
||||
git branch -M main
|
||||
git push -uf origin main
|
||||
```
|
||||
|
||||
## Integrate with your tools
|
||||
|
||||
- [ ] [Set up project integrations](https://gitlab.com/gamexperience/vision/-/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)
|
||||
- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)
|
||||
- [ ] [Automatically merge when pipeline succeeds](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html)
|
||||
|
||||
## Test and Deploy
|
||||
|
||||
Use the built-in continuous integration in GitLab.
|
||||
|
||||
- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html)
|
||||
- [ ] [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!). Thank you to [makeareadme.com](https://www.makeareadme.com/) for this template.
|
||||
|
||||
## Suggestions for a good README
|
||||
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.
|
||||
|
||||
## Name
|
||||
Choose a self-explaining name for your project.
|
||||
|
||||
## Description
|
||||
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.
|
||||
|
||||
## Badges
|
||||
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
|
||||
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.
|
||||
- Php ^8.0
|
||||
- Php extensions : bz2, curl, fileinfo, gd, intl, mbstring, mysqli, openssl, pdo_mysql, xsl
|
||||
- Git (easier way to install and update)
|
||||
- Composer (<https://getcomposer.org/download/>)
|
||||
- An SQL server
|
||||
- A mail server (or a smtp to send mail)
|
||||
- Donuts (because cops will use this panel)
|
||||
|
||||
## Installation
|
||||
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
|
||||
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.
|
||||
1. Clone the repo with the tool of your choice
|
||||
|
||||
## Support
|
||||
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.
|
||||
2. Enter the folder created
|
||||
|
||||
## Roadmap
|
||||
If you have ideas for releases in the future, it is a good idea to list them in the README.
|
||||
3. Copy the "dotEnvDemo" file to ".env", and set all required informations
|
||||
|
||||
## Contributing
|
||||
State if you are open to contributions and what your requirements are for accepting them.
|
||||
4. Install all dependencies with composer
|
||||
|
||||
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.
|
||||
```bash
|
||||
composer install --no-scripts
|
||||
```
|
||||
|
||||
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.
|
||||
5. Setup the database with symfony commands
|
||||
|
||||
## Authors and acknowledgment
|
||||
Show your appreciation to those who have contributed to the project.
|
||||
> info: If you use the symfony cli, you can replace "php bin/console" by
|
||||
> "symfony console"
|
||||
|
||||
## License
|
||||
For open source projects, say how it is licensed.
|
||||
```bash
|
||||
php bin/console doctrine:database:create
|
||||
php bin/console doctrine:migrations:migrate
|
||||
```
|
||||
|
||||
## Project status
|
||||
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.
|
||||
> info: if you start your database with docker-compose, the database is
|
||||
> already created, so ignore the "doctrine:database:create" command
|
||||
|
||||
6. Add a new group to Vision
|
||||
|
||||
```bash
|
||||
php bin/console vision:addgroup
|
||||
```
|
||||
|
||||
7. Add a new rank to this new group
|
||||
|
||||
```bash
|
||||
php bin/console vision:addrank
|
||||
```
|
||||
|
||||
8. Add a new user to vision, and choose group and rank
|
||||
|
||||
```bash
|
||||
php bin/console vision:adduser
|
||||
```
|
||||
|
||||
info : the user is created with a random password, so at first time, you need to reset your password before login
|
||||
info : If this is your admin account; dont forget to answer yes while asking if user is admin
|
||||
|
||||
9. Start vision the way you want !
|
||||
|
||||
with symfony cli:
|
||||
|
||||
```bash
|
||||
symfony serve
|
||||
```
|
||||
|
||||
or with php dev server :
|
||||
|
||||
```bash
|
||||
php -S localhost:8000 -t public
|
||||
```
|
||||
|
||||
and navigate to localhost:8000 with your web browser
|
||||
|
||||
## Update
|
||||
|
||||
1. Enter the folder containing Vision
|
||||
|
||||
2. update by pulling the repo
|
||||
|
||||
```bash
|
||||
git pull
|
||||
```
|
||||
|
||||
3. update the database with symfony commands
|
||||
|
||||
```bash
|
||||
php bin/console doctrine:migrations:migrate
|
||||
```
|
||||
|
||||
4. clear cache
|
||||
|
||||
```bash
|
||||
php bin/console cache:clear
|
||||
```
|
||||
|
||||
## Scalability
|
||||
|
||||
Vision is ready to be used in scaled architecture :
|
||||
|
||||
- user's sessions are stored in database
|
||||
- just share the "public\uploads" folder between Visions instances to get uploaded files accross instances
|
||||
|
||||
## Suggest an idea
|
||||
|
||||
Feel free to suggest your idea !
|
||||
|
||||
> [Open an Enhancement issue ! click here](https://gitlab.com/gamexperience/vision-dev/-/issues/new?issuable_template=Enhancement)
|
||||
|
||||
## Report a bug
|
||||
|
||||
You found something wrong on Vision ?
|
||||
|
||||
> [Open an a bug issue ! click here](https://gitlab.com/gamexperience/vision-dev/-/issues/new?issuable_template=Bug)
|
||||
|
||||
## Contributing
|
||||
|
||||
Contributions are always welcome!
|
||||
|
||||
Start by installing Vision on your computer, then create a .env.local file with
|
||||
|
||||
```env
|
||||
APP_ENV=dev
|
||||
```
|
||||
|
||||
Then, our way to do it :
|
||||
|
||||
1. install docker and docker compose on your computer
|
||||
|
||||
<https://www.docker.com>
|
||||
|
||||
(example: <https://www.docker.com/products/docker-desktop>)
|
||||
|
||||
2. install symfony cli on your computer
|
||||
|
||||
<https://symfony.com/download>
|
||||
|
||||
3. use docker-compose to run a mysql server and MailDev
|
||||
|
||||
```bash
|
||||
docker-compose up -d
|
||||
```
|
||||
|
||||
4. Setup database : read #5 on installation part
|
||||
you can also do the #6 - #7 to create groups and ranks, or use inclued fixtures :
|
||||
|
||||
```bash
|
||||
symfony console d:f:l
|
||||
```
|
||||
|
||||
5. Create your first Admin user : read #8 on installation part
|
||||
|
||||
6. start the symfony web server
|
||||
|
||||
```bash
|
||||
symfony serve
|
||||
```
|
||||
|
||||
with docker and symfony serve, symfony app will communicate the best way with docker
|
||||
|
||||
## Base idea by
|
||||
|
||||
- [@Xbird_](https://twitter.com/xbird_)
|
||||
- @Ajanvier
|
||||
|
||||
# Thanks
|
||||
Thanks to all contributors of Vision
|
||||
We want to thanks too the community of the French Roleplay server [GTRP](https://www.gtrp.co/), [with a special message](gtrp.co.md)
|
||||
|
||||
## Sources
|
||||
|
||||
- Symfony and packages : list in composer.json
|
||||
- Logo font : <https://fontsfree.net/garde-font-download.html>
|
||||
- Logo Icon : [@Xbird_](https://twitter.com/xbird_) with icon from FontAwesome
|
||||
- Design : <https://dashboardkit.io/>
|
||||
- Icons : cryptofont - feather - fontawesome - material
|
||||
- Wysiwyg editor : TinyMCE
|
||||
- Lightbox : Ekko Lightbox
|
||||
|
||||
Reference in New Issue
Block a user