_ NAVS is a project that securely stores and verifies Nigeria's address system. Using this data, people can check the real-world validity of their address, helping to reduce fraud. _
- Create a new project.
- Copy these files into the new project
- Update the README, replacing the contents below as prescribed.
- Add any libraries, assets, or hard dependencies whose source code will be included in the project's repository to the Exceptions section in the TERMS.
- If no exceptions are needed, remove that section from TERMS.
- If working with an existing code base, answer the questions on the open source checklist
- Delete these instructions and everything up to the Project Title from the README.
- Write some great software and tell people about it.
Keep the README fresh! It's the first thing people see and will make the initial impression.
To install all of the template files, run the following script from the root of your project's directory:
///
Goal: The goal of our project is to develop a system that securely stores and verifies Nigeria's address-based information. The system would be the first of its kind in the region and will address quality assurance concerns such as fraud, absenteeism, and inaccurate data entry.
Other things to include:
- Technology stack:
- Status: Alpha, Beta, 1.1, etc. It's OK to write a sentence, too. The goal is to let interested people know where this project is at. This is also a good place to link to the CHANGELOG.
- Links to project
- The link will be available once the version 1 of the project is completed
Screenshot: If the software has visual components, place a screenshot after the description; e.g.,
Describe any dependencies that must be installed for this software to work. This includes programming languages, databases or other storage mechanisms, build tools, frameworks, and so forth. If specific versions of other software are required, or known not to work, call that out.
- How to install the application
If the software is configurable, describe it in detail, either here or in other documentation to which you link.
How to use the NAVS
If the software includes automated tests, detail how to run those tests.
Document any known significant shortcomings with the software.
If you have questions, concerns, bug reports, etc, please file an issue in this repository's Issue Tracker.
General instructions on how to contribute should be stated with a link to CONTRIBUTING.
- Projects that inspired you
- Related projects
- Books, papers, talks, or other sources that have meaningful impact or influence on this project