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.

Sign up for GitHub

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

chore: Improve readme quality #3763

Merged
merged 3 commits into from
Jan 17, 2020
Merged

chore: Improve readme quality #3763

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
50acfc3
refactor README.md
snitin315 Jan 4, 2020
a637168
Merge branch 'development' into development
snitin315 Jan 17, 2020
f2abdd3
Merge branch 'development' into development
abhinavk96 Jan 17, 2020
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
73 changes: 38 additions & 35 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ The front end for the **Open Event Server**
[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy)

**API Documentation:**
- Every installation of the **Open Event Server** project includes API docs, (e.g. here on the test install [https://open-event-api.herokuapp.com](https://open-event-api.herokuapp.com)).
- A hosted version of the API docs is available in the `gh-pages` branch of the **Open Event Server** repository at [http://dev.eventyay.com/api/v1](http://dev.eventyay.com/api/v1)
- Every installation of the **Open Event Server** project includes API docs, (e.g. here on the test install [https://open-event-api.herokuapp.com](https://open-event-api.herokuapp.com)).
- A hosted version of the API docs is available in the `gh-pages` branch of the **Open Event Server** repository at [http://dev.eventyay.com/api/v1](http://dev.eventyay.com/api/v1)

## Communication

Expand All @@ -28,14 +28,14 @@ Please join our [Mailing list](https://groups.google.com/forum/#!forum/open-even

The Open Event Frontend can be easily deployed on a variety of platforms. Detailed platform specific instructions have been provided below.

1. [Local Installation](/docs/installation/local.md)
1. [Publish to GitHub Pages](/docs/installation/Publish-to-GitHub-Pages.md)
1. [Running in Docker](/docs/installation/docker.md)
1. [Local Installation](/docs/installation/local.md)
2. [Publish to GitHub Pages](/docs/installation/Publish-to-GitHub-Pages.md)
3. [Running in Docker](/docs/installation/docker.md)

## Running / Development

* `ember serve`
* Visit your app at [http://localhost:4200](http://localhost:4200).
- `ember serve`
- Visit your app at [http://localhost:4200](http://localhost:4200).

### Code Generators

Expand All @@ -45,14 +45,13 @@ Make use of the many generators for code, try `ember help generate` for more det

This project has acceptance, integration and unit tests located inside the `tests/` folder.

* `ember test` - CLI output
* `ember test --server` - Live browser preview and console access
- `ember test` - CLI output
- `ember test --server` - Live browser preview and console access

### Building

* `ember build` (development)
* `ember build --environment production` (production)

- `ember build` (development)
- `ember build --environment production` (production)

## Deployments, Docker images and Releases

Expand All @@ -62,51 +61,55 @@ This project has acceptance, integration and unit tests located inside the `test
The master branch of open-event-frontend gets deployed in a production environment at [https://eventyay.com](https://eventyay.com)
It consumes the API exposed by master branch deployment of open event server, hosted at [https://api.eventyay.com](https://api.eventyay.com)

**Development branch**
#### Development branch

The **development** branch of open-event-frontend gets deployed at [https://open-event-fe.netlify.com](https://open-event-fe.netlify.com)
It consumes the API exposed by development branch of open event server, hosted at [https://open-event-api-dev.herokuapp.com](https://open-event-api-dev.herokuapp.com)


### Release Cycle

Stable versions will released periodically, starting from version 1.0.0 when open-event-frontend went into production. Version names will follow [semantic versioning](https://semver.org/)

### Docker Hub Images
Docker images hosted on [open-event-frontend repository](https://cloud.docker.com/u/eventyay/repository/docker/eventyay/open-event-frontend) under eventyay organisation on docker hub are updated for each push on master and developement branch. Separate tags for each version release are also maintained. They are as follows:

|Branch/Release | Image|
|---|---|
|Master| eventyay/open-event-frontend:latest|
|Development | eventyay/open-event-frontend:development |
|Version(vx.y.z) | eventyay/open-event-frontend:vx.y.z|
| Branch/Release | Image |
| --------------- | ---------------------------------------- |
| Master | eventyay/open-event-frontend:latest |
| Development | eventyay/open-event-frontend:development |
| Version(vx.y.z) | eventyay/open-event-frontend:vx.y.z |

## Further Reading / Useful Links
* [ember.js](https://emberjs.com/)
* [ember-cli](https://ember-cli.com/)
* [Semantic UI](https://semantic-ui.com/)
* [Semantic-UI-Ember](https://semantic-org.github.io/Semantic-UI-Ember/)
* Development Browser Extensions
* [ember inspector for chrome](https://chrome.google.com/webstore/detail/ember-inspector/bmdblncegkenkacieihfhpjfppoconhi)
* [ember inspector for firefox](https://addons.mozilla.org/en-US/firefox/addon/ember-inspector/)

- [ember.js](https://emberjs.com/)

- [ember-cli](https://ember-cli.com/)

- [Semantic UI](https://semantic-ui.com/)

- [Semantic-UI-Ember](https://semantic-org.github.io/Semantic-UI-Ember/)

- Development Browser Extensions
- [ember inspector for chrome](https://chrome.google.com/webstore/detail/ember-inspector/bmdblncegkenkacieihfhpjfppoconhi)
- [ember inspector for firefox](https://addons.mozilla.org/en-US/firefox/addon/ember-inspector/)

## Contributions Best Practices

**Commits**
### Commits

* Write clear meaningful git commit messages (Do read https://chris.beams.io/posts/git-commit/)
* Make sure your PR's description contains GitHub's special keyword references that automatically close the related issue when the PR is merged. (More info at https://github.com/blog/1506-closing-issues-via-pull-requests )
* When you make very minor changes to a PR of yours (like for example fixing a failing Travis build or some small style corrections or minor changes requested by reviewers) make sure you squash your commits afterward so that you don't have an absurd number of commits for a very small fix. (Learn how to squash at https://davidwalsh.name/squash-commits-git )
* When you're submitting a PR for a UI-related issue, it would be really awesome if you add a screenshot of your change or a link to a deployment where it can be tested out along with your PR. It makes it very easy for the reviewers and you'll also get reviews quicker.
- Write clear meaningful git commit messages (Do read [https://chris.beams.io/posts/git-commit/](https://chris.beams.io/posts/git-commit/))
- Make sure your PR's description contains GitHub's special keyword references that automatically close the related issue when the PR is merged. (More info at [https://github.com/blog/1506-closing-issues-via-pull-requests](https://github.com/blog/1506-closing-issues-via-pull-requests) )
- When you make very minor changes to a PR of yours (like for example fixing a failing Travis build or some small style corrections or minor changes requested by reviewers) make sure you squash your commits afterward so that you don't have an absurd number of commits for a very small fix. (Learn how to squash at [https://davidwalsh.name/squash-commits-git](https://davidwalsh.name/squash-commits-git) )
- When you're submitting a PR for a UI-related issue, it would be really awesome if you add a screenshot of your change or a link to a deployment where it can be tested out along with your PR. It makes it very easy for the reviewers and you'll also get reviews quicker.

**Feature Requests and Bug Reports**
### Feature Requests and Bug Reports

When you file a feature request or when you are submitting a bug report to the [issue tracker](https://github.com/fossasia/open-event-frontend/issues), make sure you add steps to reproduce it. Especially if that bug is some weird/rare one.

**Join the development**
### Join the development

* Before you join development, please set up the project on your local machine, run it and go through the application completely. Press on any button you can find and see where it leads to. Explore. (Don't worry ... Nothing will happen to the app or to you due to the exploring :wink: Only thing that will happen is, you'll be more familiar with what is where and might even get some cool ideas on how to improve various aspects of the app.)
* If you would like to work on an issue, drop in a comment at the issue. If it is already assigned to someone, but there is no sign of any work being done, please feel free to drop in a comment so that the issue can be assigned to you if the previous assignee has dropped it entirely.
- Before you join development, please set up the project on your local machine, run it and go through the application completely. Press on any button you can find and see where it leads to. Explore. (Don't worry ... Nothing will happen to the app or to you due to the exploring :wink: Only thing that will happen is, you'll be more familiar with what is where and might even get some cool ideas on how to improve various aspects of the app.)
- If you would like to work on an issue, drop in a comment at the issue. If it is already assigned to someone, but there is no sign of any work being done, please feel free to drop in a comment so that the issue can be assigned to you if the previous assignee has dropped it entirely.

## License

Expand Down