First of all, the Ideoxan Developer Team would like to personally thank you for taking the time to contribute to our project and the community!
This document contains all the necessary information to contribute to the Ideoxan project. If you have any questions, contact us at hello@ideoxan.com.
This project is maintained and governed in accordance with the project's official Code of Conduct. Agreement to its terms and conditions, along with Ideoxan's Official Terms of Service, Ideoxan's Privacy Policy and the included license (MIT) is required to contribute to this organization's project.
- Contributing to Ideoxan
The Node.js Runtime is required to run the backend server (which is what serves the website). Versions above 10.x are supported. It is suggested, to use Node 13.x. NPM is also required but typically comes installed with Node.js. You can check the Node.js version by doing
node -vThe Git CLI is required to download the code from the repository.
A modern browser that supports the ES6 specs for JS are required to view the website Chrome/Chromium, Firefox, and Safari will do.
While MongoDB is not 100% needed to run the website, we suggest you install it anyways so logins and user verification can be used. To install MongoDB see their documentation guide. Make sure the server is running on localhost or another location specified in the local or system list of Environment Variables
Use the following to download the repository and install the needed packages:
git clone https://github.com/ideoxan/ideoxan.git
cd ideoxan
npm installThe server supports using both system-wide and local environment variables. If you are unable to set a system-wide environment variable, then create a .env file in the main Ideoxan directory. Make sure that your node environment is not set to production otherwise the environment variables will not be used locally. The following is a list of used environment variables. If any of them are conflicting, please inform us.
MONGO_URI
EXPRESS_SESSION_SECRET
PWD_HASHThe MONGO_URI environment variable is used to set the URI of the MongoDB database. This URI must be a valid MongoURI String. The default is mongodb://localhost:27017/ix
The EXPRESS_SESSION_SECRET environment variable is the secret that all of the sessions authenticated with that server will use. It is best to keep this secure and safe as this can be used to invalidate, modify, and spoof sessions (which is not good). Keep this as long and as complex as possible. There is no default due to security reasons.
The PWD_HASH environment variable is a integer value that is used to hash passwords within the bcryptjs module. Keep the number high enough where the passwords are secure but low enough that it doesn't cause the server to slow down. Again, for security reasons, there is no default value.
If you are looking to contribute to a course or lesson, please see our other GitHub repos with the prefix of curriculum-. All of our curriculum guides are kept on GitHub (not all are publicly available) and are stored serverside under /static/curriculum and are requested by the client side under the static Express directory (/static). The curriculum is not included with the editor, website, or any of its contents. Under Git, these courses are included as submodules and can be installed under the curriculum directory by using the following:
git submodule init
git submodule update --recursiveThis will clone, fetch, and pull all publicly available courses. If you would like to know more about Git Submodules and how they work click here.
There are two main branches that are used: master and prod. The prod branch is what is sent out for production and deployment. We try to only update this branch every so often when needed (hotfixes are slower to be merged). The master branch is is where a majority of our new commits go to. Think of this as a fresh nightly build system. While this branch has the newest code, it doesn't mean its the most stable. If you plan on using this on the long term and don't feel like updating every 20 minutes, we suggest you use the prod branch.
There are three options to run the server.
Developer Mode is the command to run the server on a development machine. This allows for easy editing and quick server startup. It relies on the Nodemon package, so ensure that the developer dependencies outlined in the package.json file are installed via NPM.
To run the server locally use:
npm run devTo startup the server without any additional features, run:
npm run startThis automatically updates any included submodules and then starts the server. Alternatively, the server can be started up just like any normal Node.js project:
node server.jsThis method is not suggested to be used since this option is personally tailored for specific servers used by Ideoxan.
This requires PM2 to be installed globally.
npm run serverIf that does not work use:
pm2 start server.js --name ideoxan --max-memory-restart 500M --watch --cron "0 2 * * *"First and foremost, if you believe the issue to be one pertaining to security, DO NOT OPEN AN ISSUE. REPORT THE BUG DIRECTLY TO US THROUGH EMAIL
The issue you are reporting is typically a security issue when...
- You can access, view, edit, or in any way alter something that is not yours
- You have discovered something that most likely is not the work of Ideoxan, its partners, packages, contributors, verified advertisers or maintainers on the site, in the code repository, or anywhere else
- You have discovered a possible way to abuse the API, site, or server
- Your system has been compromised because of the usage of Ideoxan and its products
If you have experienced any of the above, this is most likely the result of a possible security risk and should be reported. Failure to report could result in possible legal action on our behalf.
Even if your issue does not meet the above and still believe it is a security related issue, do not hesitate to email us. It’s better to be safe rather than to be sorry.
Please check the following to ensure that you are cleared to open an issue.
If your issue has to do with the Node.js runtime, any of the packages/software that is not covered/maintained by Ideoxan, or anything else, then this is not the proper place to file your issue with. If you need help being directed to the proper bug tracker or troubleshooting guide, feel free to contact us. (See Contact Us)
If you have modified any of the source, there is a high probability that the issue has been caused by tampering. If the issue still persists after reverting your code, open an issue.
We do not support old software. Please check your versions against the ones specified in the master branch's package.json/package-lock.json and in the Pre-requisites Section in our Contributing guide.
If the issue has already been reported and it is still open on our GitHub, please comment your issue rather than opening a new issue. If it is not still open check the status of it. If it has the wont-fix tag attached to the issue, do not bring it up again unless you see it as a prominent issue and a significant amount of time has passed. Also check to see if there is a solution. Sometimes issues will be closed not because they were marked as invalid or a solution was reached but because of a lack of activity. If you find this to be the case, feel free to request the issue to be re-opened.
If you issue relates to security, please see Reporting Security Issues.
If you followed the above and met the requirements, you can now open an issue. Make sure to use a descriptive title, and clearly describe your issue. Be sure to follow the bug report template (strongly suggested). If you fail to describe your issue properly your issue will be closed without explanation.
If you are contributing to the codebase (does not include documentation), please make sure to follow our standards.
Please check if there are already any issues open that can be resolved. If not, make sure that a pull request doesn't already cover what you are attempting to merge.
If you are sure of the above, open a pull request using our PR Template
If you are suggesting that Ideoxan adds a new feature or expands upon an existing one, please open an issue using the Feature Request Template
Coming Soon
If you have a question or concern that doesn't meet the above, feel free to reach out to us (See Contact Us)
This repository strives to allow for compatibility, uniformity, and overall legibility. We suggest if you are attempting to contribute to this project's source, that you read the following.
Coming Soon
| Label | Description | Search |
|---|---|---|
| Critical Bug | A bug that hinders the website completely useless and is critical to basic operation/management | 🔎 |
| Bug (Medium) | A bug of medium severity that impacts a significant portion of the site and/or its users. | 🔎 |
| Bug (Low) | A low priority bug that barely has any impact on the site and/or its users | 🔎 |
| Label | Description | Search |
|---|---|---|
| Duplicate | An issue that is a duplicate of a previous, closed (solved) issue, open (pending) issue, or a closed pull request | 🔎 |
| Won't Fix | An issue unrelated to the project or and issue that can not be resolved | 🔎 |
| Invalid | An issue that has no prevalence to the project or can not be replicated | 🔎 |
| Question | More information must be provided for the question to be valid | 🔎 |
| Label | Description | Search |
|---|---|---|
| Website | A website-related issue | 🔎 |
| Server | A server-related issue | 🔎 |
| Documentation | An issue related to the documentation of the site, server, or API | 🔎 |
| Other | An issue that does not deal with either the website, server or documentation | 🔎 |
| Enhancement | A suggestion for a new feature under consideration or an improvement of an already existing one | 🔎 |
| Label | Description | Search |
|---|---|---|
| Help Wanted | A tag given to an issue or pull request that needs external review or contribution. Usually if given, the issue is either out of the scope of knowledge of the maintainers or is not of the highest priority. | 🔎 |
| Good First Issue | If you are new around here, this is a great place to start! This is either an active issue or a good example of an issue for newcomers to tackle. | 🔎 |
If you need to reach out, please contact us at the following links below
- E-Mail: hello@ideoxan.com
- Discord: Ideoxan Community Server
More platforms will be added in the future.