Skip to content

Latest commit

 

History

History
116 lines (73 loc) · 4.74 KB

Readme.md

File metadata and controls

116 lines (73 loc) · 4.74 KB
Raw

Open Event Check-In

Netlify Status Codacy Badge Gitter Mailing Twitter Follow

Communication

Please join our mailing list or chat channel to get in touch with the developers.

Installation

Easily deployed on a variety of platforms. Detailed platform specific instructions have been provided below.

Local

Clone or Fork the codebase and following instructions below.

Github Pages (using Github Actions)

Refer to the workflow for deployment.

Running / Development

After cloning the codebase, install packages:

npm i

Running:

npm run dev

Visit your app at http://localhost:8080.

Lint with ESLint

npm run lint

Format code with Prettier

npm run format

Running Tests (WIP)

Unit Tests with Vitest

npm run test:unit

End-to-End Tests with Cypress

npm run test:e2e:dev

Building for Production

npm build

Deployments and Releases

Deployments

Master branch

Deployed in a production environment at checkin.eventyay.com it consumes the API exposed by master branch deployment of open event server, hosted at api.eventyay.com.

Development branch

Only deployed locally with npm run dev or Netlify when you make a pull request it consumes the API exposed by development branch of open event server, hosted at test-api.eventyay.com.

Further Reading / Useful Links

Contributions Best Practices

Commits

  • Write clear meaningful git commit messages (Do read 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 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 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.

Join the development

  • Before you join development, please set up the project on your local machine, run it and go through the application completely.
  • 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.

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