Skip to content

Latest commit

 

History

History
133 lines (81 loc) · 7.75 KB

README.md

File metadata and controls

133 lines (81 loc) · 7.75 KB
Raw

Open Event Frontend

Open Event Frontend

Build Status Netlify Codacy Badge codecov Known Vulnerabilities Weblate Gitter Mailing Twitter Follow

The front end for the Open Event Server

Deploy

API Documentation:

Communication

Please join our Mailing list or chat channel 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
  2. Publish to GitHub Pages
  3. Running in Docker

Running / Development

Click to see installation video

Note: Please follow installation 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:

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 It consumes the API exposed by master branch deployment of open event server, hosted at https://api.eventyay.com

Development branch

The development branch of open-event-frontend gets deployed at https://open-event-frontend.now.sh/ It consumes the API exposed by development branch of open event server, hosted at https://open-event.dokku.fossasia.org

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

Docker Hub Images

Docker images hosted on open-event-frontend repository 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

Contributions Best Practices

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.

Feature Requests and Bug Reports

When you file a feature request or when you are submitting a bug report to the issue tracker, 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 😉 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

This project is currently licensed under the Apache License version 2.0.

To obtain the software under a different license, Please contact FOSSASIA.