LEAD Points - Kent Institute ·

The LEAD Points app has been develop to foment the student engagement with Kent's events, workshops and social activities.

Development server

• Run npm start for a dev server. The app will automatically reload if you change any of the source files.

• Run npm run serve to access the app over the network and test it on mobile.

Build

Run npm run build to build the project. The build artifacts will be stored in the dist/ directory. Use the npm run build-prod flag for a production build.

Contributing

Developing

1. Create a new feature branch feature/<NameOfTheFeature> from the develop branch

2. Make changes

3. Update the CHANGELOG file

4. Commit all changes

5. Run npm test

6. Open a Pull request to merge your changes to the develop branch

7. Make sure Travis turns green

8. Wait for an admin approval

Deploying to production

To release a new version do the following steps:

1. Merge the develop branch to the master branch

2. Checkout to the master branch

3. On the master branch run one of the following commands

npm version patch
npm version minor
npm version major

Which will...

• Build a production version of the app
• Bump the version
• Create a tag with the new version
• Push the code with the tags to the repo
• Start the CI script
• Checkout, merge and push the new Bump to the develop branch

The code it's automatically uploaded to production when committed to the master branch if passed the tests.

Alternatively, you can run firebase deploy:prod to update the host Firebase CLI

Further help

This project was generated with Angular CLI

To get more help on the Angular CLI use ng help or go check out the Angular CLI README.

Built With

• Angular - The framework used
• Angular Material - Material Design components for Angular
• Angular Flex Layout - Material Design components for Angular
• Firebase - Used as host, storage and fireStore as a DB

Plugins

• ng2-img-max - Angular 2 module to resize images down to a certain width and height or to reduce the quality to fit a certain maximal filesize - all in the browser.

Dev tools

• Prettier - Prettier is an opinionated code formatter.
• Husky - Git hooks made easy.
• Travis CI - Easily sync your GitHub projects with Travis CI and you'll be testing your code in minutes.
• NPM - Build amazing things.
• Cypress - Fast, easy and reliable testing for anything that runs in a browser.

Authors

• Renan Sigolo

License

• This project is licensed under the APACHE 2.0 License - see the LICENSE.md file for details

Acknowledgments

• Thanks to everyone at Kent Institute
• Inspiring the world to be more collaborative