Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fossasia/open-event-frontend
The frontend for the Open Event API Server https://test.eventyay.com
https://github.com/fossasia/open-event-frontend
Last synced: 25 days ago
JSON representation
The frontend for the Open Event API Server https://test.eventyay.com
- Host: GitHub
- URL: https://github.com/fossasia/open-event-frontend
- Owner: fossasia
- License: apache-2.0
- Created: 2017-04-06T22:04:57.000Z (over 7 years ago)
- Default Branch: development
- Last Pushed: 2024-04-13T12:24:41.000Z (7 months ago)
- Last Synced: 2024-10-01T22:41:14.045Z (about 1 month ago)
- Language: JavaScript
- Homepage: https://eventyay.com
- Size: 59.3 MB
- Stars: 2,333
- Watchers: 23
- Forks: 1,814
- Open Issues: 66
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome-starred - fossasia/open-event-frontend - The frontend for the Open Event API Server https://test.eventyay.com (others)
- jimsghstars - fossasia/open-event-frontend - The frontend for the Open Event API Server https://test.eventyay.com (JavaScript)
README
# Open Event Frontend
[](https://github.com/fossasia/open-event-frontend/actions?query=workflow%3Aci)
[](https://app.netlify.com/sites/open-event/deploys)
[](https://www.codacy.com/gh/fossasia/open-event-frontend/dashboard?utm_source=github.com&utm_medium=referral&utm_content=fossasia/open-event-frontend&utm_campaign=Badge_Grade)
[](https://codecov.io/gh/fossasia/open-event-frontend)
[](https://snyk.io/test/github/fossasia/open-event-frontend)
[](https://hosted.weblate.org/projects/open-event/frontend/)
[](https://gitter.im/fossasia/open-event-frontend)
[](https://groups.google.com/forum/#!forum/open-event)
[](https://twitter.com/eventyay)
The front end for the **Open Event Server**
**API Documentation:**
- Every installation of the **Open Event Server** project includes API docs
- A hosted version of the API docs is available in the `gh-pages` branch of the **Open Event Server** repository at [http://api.eventyay.com](http://api.eventyay.com)
## Communication
Please join our [Mailing list](https://groups.google.com/forum/#!forum/open-event) or [chat channel](https://gitter.im/fossasia/open-event-frontend) to get in touch with the developers.
## Installation
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)
2. [Publish to GitHub Pages](/docs/installation/Publish-to-GitHub-Pages.md)
3. [Running in Docker](/docs/installation/docker.md)
## Running / Development
[Click to see installation video](https://youtu.be/BNi492mJyD4)
**Note**: Please follow [installation steps](/docs/installation/local.md#steps) listed above carefully before running
Unfortunately, no one reads the note above, so please just run the following commands when setting up for the first time:
- `yarn`
- `cp .env.example .env`
- `yarn l10n:generate`
Running:
- `yarn start`
- Visit your app at [http://localhost:4200](http://localhost:4200).
### Code Generators
Make use of the many generators for code, try `ember help generate` for more details.
### Running Tests
This project has acceptance, integration and unit tests located inside the `tests/` folder.
- `yarn test` - CLI output
- `yarn test --server` - Live browser preview and console access
### Building
- `yarn build` (development)
- `yarn build -prod` (production)
## Deployments, Docker images and Releases
### Deployments
**Master branch**
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
The **development** branch of open-event-frontend gets deployed at [https://open-event-frontend.now.sh/](https://open-event-frontend.now.sh/)
It consumes the API exposed by development branch of open event server, hosted at [https://test.eventyay.com](https://test.eventyay.com)
### Release Cycle
Stable versions will be 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 development 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 |
## 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/)
## Contributions Best Practices
### Commits
- 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
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
- 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 with the estimated completion date 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.
## License
This project is currently licensed under the [Apache License version 2.0](LICENSE).
To obtain the software under a different license, Please contact **[FOSSASIA](https://blog.fossasia.org/contact/)**.