Skip to content

Latest commit

 

History

History
155 lines (109 loc) · 4.38 KB

README.md

File metadata and controls

155 lines (109 loc) · 4.38 KB
Raw

Sportiv Logo

Project name

GitHub repo size GitHub contributors GitHub stars GitHub forks

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.

Prerequisites

Before you begin, ensure you have met the following requirements:

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

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

Test

# unit tests
$ npm run test

# e2e tests
$ npm run test:e2e

# test coverage
$ npm run test:cov

Advanced

# 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

BASE_URL_API_TOURNAMENT=
BASE_URL_SPORTIV=
SRC_URL_SPORTIV=

Production

BASE_URL_API_TOURNAMENT=
BASE_URL_SPORTIV=
SRC_URL_SPORTIV=

Contributing to <project_name>

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.

Contributors

Thanks to the following people who have contributed to this project:

You might want to consider using something like the All Contributors specification and its emoji key.

Contact

If you want to contact me you can reach me at your_email@address.com.

License

This project uses the following license: <license_name>.