Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Better Doc #108

Merged
merged 6 commits into from
Mar 1, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions .github/issue_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
## Issue Template

### Type of Issue

- [ ] Bug
- [ ] Feature Request
- [ ] Documentation
- [ ] Other

### Description

Please provide a brief description of the issue.

### Steps to Reproduce

Please provide detailed steps to reproduce the issue if it is a bug.

### Expected Behavior

Please provide a description of the expected behavior if it is a bug or a feature request.

### Screenshots

If applicable, add screenshots to help explain the issue.

### Additional Context

Add any other context about the issue here.
19 changes: 19 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
## Description

Please provide a brief description of the changes made in this pull request.

## Checklist

- [ ] I have tested the changes locally and they work as expected.
- [ ] I have tested the responsiveness of the changes and they work as expected.
- [ ] I have assigned the pull request to the appropriate reviewer(s).
- [ ] I have added labels to the pull request, if necessary.

## Related Issues

Please list any related issues or pull requests here.

## Screenshots

If applicable, add screenshots to help explain the changes made.

34 changes: 15 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,22 @@
# Contributing
# Insalan Frontend

Please read carefully[the CONTRIBUTING.md file](CONTRIBUTING.md) before any
contribution.
## Description

# Run the frontend in local
This is the frontend of the Insalan website. It is a Vue.js application. It is
served by a Nginx server. It is part of the [insalan.fr](https://insalan.fr)
infrastructure and is deployed with the
[infra-insalan.fr](https://github.com/InsaLan/infra-insalan.fr) repository.

The frontend has to be deployed from the docker-compose setup (so you need to install it!).
Please refer to [this README](https://github.com/InsaLan/infra-insalan.fr/blob/main/README.md)
## Contributing

The front is available here: dev.insalan.localhost
Please read carefully [the CONTRIBUTING.md file](CONTRIBUTING.md) before any
contribution.

# To Do
## Run the frontend in local

- [ ] Partenaire [PiphPaf](https://github.com/PiphPaf)
- [ ] Tournois [Istar](https://github.com/istar410)
- [ ] /user/me [Kwikkill](https://github.com/KwikKill)
- [ ] Reset Password Astiqueur
- [ ] Linting [Dyskal](https://github.com/Dyskal)
- [ ] Erreur
- [ ] Infos Ecnama
- [ ] Localisation
- [ ] Pizza (secondaire)
- [ ] Restauration (secondaire)
- [ ] Pimp Enregistrement (secondaire)
The frontend has to be deployed from the docker-compose setup (so you need to
install it!). Please refer to [this
README](https://github.com/InsaLan/infra-insalan.fr/blob/main/README.md)

Once the docker-compose is running, you can access the frontend at
`http://beta.insalan.localhost` if you are using the default beta configuration.
Loading