tnatanael / sign

Welcome to Sign

Brief intro to the repo

This is an admin dashboard application for a school attendance marking system.

Getting Started

This is a simple PHP application. Learn how to setup this project and run it on your local machine.

How to clone the repo

• On GitHub, navigate to the main page of the repository.
• Under the repository name, click Clone or Download and copy the URL.
• Open Terminal.
• Change the current working directory to the location where you want the cloned directory to be made.
• Type git clone, and then paste the URL you copied in Step 2. $ git clone https://github.com/YOUR-USERNAME/sign
• Press Enter. Your local clone will be created at: $ git clone https://github.com/YOUR-USERNAME/sign

Read more here: (cloning-a-repository)[https://help.github.com/en/articles/cloning-a-repository]

How to run on the local apache server

• For Mac: (osxdaily.com/start-apache-web-server/)[http://osxdaily.com/2012/09/02/start-apache-web-server-mac-os-x/]
• For Windows: (msdn.microsoft.com/library/)[https://msdn.microsoft.com/en-us/library/ms181052(v=vs.80).aspx]
• For something else: (gist.github.com/jgravois/)[https://gist.github.com/jgravois/5e73b56fa7756fd00b89]

If you've never contributed before, see the first timer's guide on our blog for resources and tips on how to get started.

Setting up the project

• Install the prerequisites - Apache / any PHP web server, NodeJS and MongoDB.
• Setup backend project invloving node.js server and MongoDB. Refer to Student Attendance System (Back end).
• Setup the base directory with Apache / any PHP web server.
• Update the URLs in properties.js to point to your backend endpoints.
• You may create an admin user to access the dashboard using the /user API endpoint of the backend.

Dependencies

This project uses the following dependencies:

• Chart.js
• Bootstrap
• Flag-icon-css
• Chosen-js
• Grunt-cli
• Gulp
• Popper.js
• Tooltip.js
• Jquery
• Datatables.net-bs4
• Datatables.net-buttons-bs4
• Datatables.net-buttons
• Datatables.net

Contribution guidelines

Contributions are made to this repo via Issues and Pull Requests (PRs). A few general guidelines that cover both:

• Search for existing Issues and PRs before creating your own.
• We work hard to makes sure issues are handled in a timely manner but, depending on the impact, it could take a while to investigate the root cause. A friendly ping in the comment thread to the submitter or a contributor can help draw attention if your issue is blocking.

Issues

Issues should be used to report problems with the library, request a new feature, or to discuss potential changes before a PR is created. When you create a new Issue, a template will be loaded that will guide you through collecting and providing the information we need to investigate.

If you find an Issue that addresses the problem you're having, please add your own reproduction information to the existing issue rather than creating a new one.

Pull Requests

PRs to this repo are always welcome and can be a quick way to get your fix. In general, PRs should:

• Fix/add the functionality in question.
• Address wide-spread whitespace/style issues.
• Address a single concern in the least number of changed lines as possible.
• Include documentation in the repo.
• Be accompanied by a complete Pull Request template (loaded automatically when a PR is created).

In general, we follow the "fork-and-pull" Git workflow

1. Fork the repository to your own Github account
2. Clone the project to your machine
3. Create a branch locally with a succinct but descriptive name
4. Commit changes to the branch
5. Following any formatting and testing guidelines specific to this repo
6. Push changes to your fork
7. Open a PR in our repository and follow the PR template so that we can efficiently review the changes.

License

This work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.

Versioning

Coming soon 🤘
PRs are welcome.

Authors

Awesome people who made this repo are: @tharakanandakumara @ShanikaEdiriweera