seedIAM (seed Indentity Access Management)
The IAM Application is a single-signon platform for all application projects developed under the banner of "Ideas in execution" by Kanjoo Mbaindjikua. The IAM is important for security and user management. It also creates the necessary hub that organises all data flow to a single point of administration.
This project is created to be a single account that provide access and connect users to all our application. This is the beginning or the seed for our ambitious identity and access management component.
Computer and Software configurations are recommended to achieve optimum performance based on operating systems such as Windows, iOS, Android, and mobile.
This will include, but is not limited to, any packages and dependencies required to make your project function. Operating instructions — “What is this? Where does this go?” Now is the time to demystify any assumptions around how to use your project.
This project includes the following files and folders in its structure:
The bin folder is where the essential programmes/commands, that must be available even if only the partition (root file '/') is mounted, reside. So, it serves as the location for the various startup scripts. -www -test -stop -restart
This configuration is based on the express generator, and as further expanded in stackover question "what does bin www do in express?". Having this structure enables different configurations, without havving to put everything into app.js.
The public folder holds all the static files -css folder -images folder -javascript -index.html -icons
the Routes folder holds the http routes -index.js -users.js
The views folder holds the template generated dynamic views -error.ejs -index.ejs -layout.ejs
db.js app.js
In order to let others know what they can and cannot do with your code, it is important to include a software license in your project. If you opt out of using a license then the default copyright laws will apply and you will retain all rights to your source code and no one may reproduce, distribute, or create derivative works from your work. Hence the reason licenses are critical and highly recommended for open source projects.
Name, email, social media links, and any other helpful ways of getting in contact with you or members of your team.
This is the perfect place to put tickets of known issues that you are actively working on or have on backlog. Speaking of backlog, if your project is open source, this is will allow potential contributors an opportunity to review incomplete features.
In this section you will be able to highlight how your users can become troubleshooting masters for common issues encountered on your project.
Who were the contributing authors on the project, whose code did you reference, which tutorials did you watch that help you bring this project to fruition? Sharing is caring and all praises are due for those that have helped no matter how small the contribution.
(usually for programmers) — A changelog is a chronological list of all notable changes made to a project such as: records of changes such as bug fixes, new features, improvements, new frameworks or libraries used, and etc.
(usually for users) — If your project is live and in production and you are receiving feedback from users, this is a great place to let them know, “Hey, we hear you, we appreciate you, and because of your feedback here are the most recent changes, updates, and new features made.”