Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/xshadowcodingx/shadowcms

Not ready for use | Still in development, many bugs and project is incomplete for V1 | Opensource CMS and API creator. Built in JavaScript.
https://github.com/xshadowcodingx/shadowcms

api api-creation cms express expressjs free jade javascript js node nodejs open-source opensource opensource-projects pug

Last synced: about 1 month ago
JSON representation

Not ready for use | Still in development, many bugs and project is incomplete for V1 | Opensource CMS and API creator. Built in JavaScript.

Awesome Lists containing this project

README 

        
# ShadowCMS

Open Source CMS



**Do not go by this README just yet. I am working on finishing V1**



**Working on a text editor and chart library, so I can make this project completely open source** - 9/26/24



##### Key Features:



- Written in JavaScript

- Built on NodeJS

- Easy to adjust settings via settings.js

- .env file functionality



##### Adjustable Settings:



These settings make it easy quickly adjust your CMS. As I update this CMS, these settings may change, but I will keep this **README** updated as I do. You can find the *settings.js* file in */www/lib/*.



- **port**: This is the default port that the cms will run on. By default it is set to 3000. If this is omitted it will fall back to 3000.

- **logo**: This allows you to set the url of your logo if you should want to. It gives some personalization to the CMS.

- **logo_alt**: This allows you to assign the alt attribute to your logo.

- **background_image**: This allows you to assign the background image for the CMS.



***Note*: The following settings are also adjustable, but ar efound within the `.env` file at the root of the application:**



- **MODE**: This is the default mode of the application, you can set this to either *'production'* or *'development'*. If it is omitted it will default to *'development'*.

- **DATABASE_USERNAME**: This is the database username, change this to something else that is secure before moving to production.

- **DATABASE_PASSWORD**: This is the database password, change this to something else that is secure before moving to production.

- **SESSION_SIGNATURE_SECRET_KEY**: This is the secret key that will sign the cookies for session authentication. Change this to something more secure before moving to production.

- **SESSION_TIMEOUT_MS**: This is the timeout in milliseconds. It is set to 90,000ms by default which is 15 minutes. Be careful not to give too much time as it opens the door for security issues.



##### The Message Handler



The messages are customizable as well. You can easily adjust these by going to the *settings.js* file inside of of */www/lib/* and find the attribute `messages`. If any are omitted, they default back to the original message.The messages that are customizable are as follows:



- **incorrect_login**: This is the message that is displayed when the login credentials are incorrect. This could be an incorrect email, password, or both.



##### The Log Handler



This CMS has a log handler file that gives color to the logs to make it easier to notice what is happening. Errors are red, info is cyan, etc. The file is located in */www/lib/* if you want to make any changes to what is displayed. This is done by utilizing the log handler function.



By default:



- **error**: red background / white text

- **info**: cyan text

- **warning**: yellow text

- **general**: blue text



*Function:*



`loghandler(log, message)`



*Example use:*



`loghandler('warning', "This is a warning")`



##### The Views



The views in the CMS utilize Pug as the view engine. You can access the views templates within */www/routes/views/* if you want to make any changes. The styling in the views is helped by utilizing the [Bootstrap](https://getbootstrap.com/) library. The local css file can be found in */www/public/css/* if you want to make changes there as well.



##### The Database



The database is SQLITE3, and is handled via the (Sequelize ORM)[https://sequelize.org/]. The `DATABASE_USERNAME` and `DATABASE_PASSWORD` in the `.env` file should be changed immediately.



##### Hashing



All passwords are hashing utilizing the `bcryptjs` npm library. No password should be stored as plain text.



##### Sessions



Sessions are handled using the `express-sessions` npm library. This is saved to a db that can be located alongside the other database within the */www/lib/database/* folder. However, this is solely for session authentication purposes only.



##### The First User



The first time you run the CMS, it will direct you to the first user account creation page. This will allow you to make your first admin. Be sure to run this page and go through it immediately.