Join

subititle

...

...

:green_book: Table of Contents

1. Installation
2. Introduction
3. How to use it?
4. Contribution
5. License

Installation

1. Clone the repository

bash https://github.com/lascuolaopensource/join.git

2. Install all the dependencies

bash yarn install

3. Bootstrap the packages with Lerna

bash yarn boostrap

Introduction

...

How to use it?

1. Start the packages

bash yarn start

2. CMS Front-End is running at

http://localhost:8085/

3. CMS-Service is running at

http://localhost:8000/

Contribution

We are very happy to get any kind of contribution to this project and we would like to make contributions to this project as easy and transparent as possible.

When contributing to this repository, please first discuss the changes you wish to make via issue, email, or any other method with the owners of this repository before making a change.

Please note we do have a code of conduct, please follow it in all of your interactions with the project.

You can use the GitHub repository page for the following contributions:

• Reporting a bug
• Discussing the current state of the code
• Submitting a fix
• Proposing new features
• Becoming a maintainer

We use Github Flow, so all code changes happen through pull requests.

Pull requests are the best way to propose changes to the codebase. We actively welcome your pull requests.

Instructions for contributing:

1. Fork the repo and create your branch from main.
2. If you've added code that should be tested, add tests.
3. If you've changed APIs, update the documentation.
4. Ensure the test suite passes.
5. Make sure your code lints.
6. Issue that pull request!

Any contributions that you make will be under the MIT Software License

In short, when you submit the code changes, your submissions are understood to be under the same MIT License that covers the project. Feel free to contact the maintainers if that's a concern.

:bug: Report bugs using Github's issues

We use GitHub issues to track public bugs. Report a bug by [opening a new issue]().

Great Bug Reports tend to have:

• A quick summary and/or background
• Steps to reproduce
• What you expected would happen
• What actually happens

License

By contributing, you agree that your contributions will be licensed under its MIT License.