-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1 from sportivapp/docs/readme
docs(README.md): update sportiv readme
- Loading branch information
Showing
1 changed file
with
142 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1,142 @@ | ||
| # README-template.md | ||
| <p align="center"> | ||
| <img src="https://i.imgur.com/j8iwglW.png" alt="Sportiv Logo" width="250px"/> | ||
| </p> | ||
|
|
||
| # Project name | ||
|
|
||
| <!--- These are templatees. See https://shields.io for others or to customize this set of shields. You might want to include dependencies, project status and licence info here ---> | ||
|  | ||
|  | ||
|  | ||
|  | ||
|
|
||
| Project name is a `<utility/tool/feature>` that allows `<insert_target_audience>` to do `<action/task_it_does>`. | ||
|
|
||
| Your introduction should be around 2 or 3 sentences. Don't go overboard, people won't read it. | ||
|
|
||
| ## Structure | ||
|
|
||
| | Codebase | Description | | ||
| | :------------------- | :-------------------: | | ||
| | Frontend Tournament | Nuxt.js Frontend | | ||
| | Backend Tournament | Nest.js API | | ||
|
|
||
| ## Branches | ||
| - development -> pr this branch for everything else | ||
| - staging -> It'll connect to as many services as it can without touching the prod environment. | ||
| - main -> don't touch, this is what's running in prod | ||
|
|
||
| ## Code of Conduct | ||
| The code of conduct is described in [`CODE_OF_CONDUCT.md`](CODE_OF_CONDUCT.md). | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| Before you begin, ensure you have met the following requirements: | ||
| <!--- These are just example requirements. Add, duplicate or remove as required ---> | ||
| * You have installed the latest version of `<coding_language/dependency/requirement_1>` | ||
| * You have a `<Windows/Linux/Mac>` machine. State which OS is supported/which is not. | ||
| * You have read `<guide/link/documentation_related_to_project>`. | ||
|
|
||
| ## Installing `<project_name>` | ||
|
|
||
| To install <project_name>, follow these steps: | ||
|
|
||
| Linux and macOS: | ||
| ``` | ||
| <install_command> | ||
| ``` | ||
|
|
||
| Windows: | ||
| ``` | ||
| <install_command> | ||
| ``` | ||
| ## Using `<project_name>` | ||
|
|
||
| To use `<project_name>`, follow these steps: | ||
|
|
||
| ```bash | ||
| # enter the project directory | ||
| cd project_name | ||
|
|
||
| # pull from latest staging | ||
| git pull main | ||
|
|
||
| # install dependency | ||
| npm install | ||
|
|
||
| # develop | ||
| npm run dev | ||
| ``` | ||
|
|
||
| Add run commands and examples you think users will find useful. Provide an options reference for bonus points! | ||
|
|
||
| ## Advanced | ||
|
|
||
| ```bash | ||
| # preview the release environment effect | ||
| npm run preview | ||
|
|
||
| # preview the release environment effect + static resource analysis | ||
| npm run preview -- --report | ||
|
|
||
| # code format check | ||
| npm run lint | ||
|
|
||
| # code format check and auto fix | ||
| npm run lint -- --fix | ||
| ``` | ||
|
|
||
|
|
||
| ## Environment Variables | ||
|
|
||
| for running in your machine, please prepare your .env | ||
|
|
||
| Development | ||
| ```bash | ||
| BASE_URL_API_TOURNAMENT= | ||
| BASE_URL_SPORTIV= | ||
| SRC_URL_SPORTIV= | ||
| ``` | ||
| Production | ||
| ```bash | ||
| BASE_URL_API_TOURNAMENT= | ||
| BASE_URL_SPORTIV= | ||
| SRC_URL_SPORTIV= | ||
| ``` | ||
| ## Contributing to `<project_name>` | ||
| <!--- If your README is long or you have some specific process or steps you want contributors to follow, consider creating a separate CONTRIBUTING.md file---> | ||
| Hello engineers! We want to make contributing to this project as easy and transparent as possible, whether it's: | ||
|
|
||
| - Reporting an issue | ||
| - Discussing the current state of the code | ||
| - Submitting a fix | ||
| - Proposing new updates | ||
|
|
||
| To contribute to <project_name>, follow these steps: | ||
|
|
||
| 1. Clone this repository. | ||
| 2. Create a branch: `git checkout -b <branch_name>`. | ||
| 3. Add Changes: `git add -A`. | ||
| 4. Make your changes and commit them: `git commit -m -S '<commit_message>'` | ||
| 5. Push to the original branch: `git push` | ||
| 6. Create the pull request. | ||
|
|
||
| Alternatively see the GitHub documentation on [creating a pull request](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request). | ||
|
|
||
|
|
||
| ## Contributors | ||
|
|
||
| Thanks to the following people who have contributed to this project: | ||
|
|
||
| * [@andikaleonardo](https://github.com/andikaleonardo) 👽 | ||
|
|
||
| You might want to consider using something like the [All Contributors](https://github.com/all-contributors/all-contributors) specification and its [emoji key](https://allcontributors.org/docs/en/emoji-key). | ||
|
|
||
| ## Contact | ||
|
|
||
| If you want to contact me you can reach me at <your_email@address.com>. | ||
|
|
||
| ## License | ||
| <!--- If you're not sure which open license to use see https://choosealicense.com/---> | ||
|
|
||
| This project uses the following license: [<license_name>](<link>). |