Data

Tools

Indexes

Applications

Experiments

Awesome

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

https://github.com/gnat/nc-cms

:bulb: Embeddable, lightweight, simple PHP CMS. Content Management System.
https://github.com/gnat/nc-cms

cms content-management content-management-system php

Last synced: about 1 year ago
JSON representation

:bulb: Embeddable, lightweight, simple PHP CMS. Content Management System.

Awesome Lists containing this project

README 

          
Embeddable, lightweight, simple PHP CMS.

================================



Website "add-on" style integration. Retains the most important features of a modern day CMS: 



* User login.

* File uploads. 

* Edit content and page titles.

* PHP 7 and up.



**No database required.** A very fast flat file storage is used by default. A database is optional.



If you prefer to use a database backend, MySQL is available. You can also use anything else supported by PHP PDO.



Language support:



* English

* German



### Integration Sample.

```php

 



    

        

        Title('home_title'); ?> 

         

    

    

        ControlPanel(); ?> 

        


            ContentHTML('home_content'); ?> 

        


        


            LoginLink(); ?> 

        


    



```



### Login Screenshot.

nc-cms Screenshot 2



### Editor Screenshot.

nc-cms Screenshot 3



### Sample Website Screenshot.

nc-cms Screenshot 1



### Some kind words from the community...



> "I can't begin to describe to you what a life saver it is not having to rebuild an entire site on a CMS platform."



> "Overall, a very quick way to start up a stable, dynamic site with minimal overhead!"



> "Thanks for such a killer cms that is so simple.. great concept!"



### Installation.



1. Create an empty directory and switch into it.



2. Either use **git clone https://github.com/gnat/nc-cms.git .** or [download a zip](https://github.com/gnat/nc-cms/archive/master.zip) and extract it inside.



3. Edit **/nc-cms/config.php**. Set all of the general settings. If you would like to use nc-cms's database support (optional), set **NC_USE_DB** to **true** and configure the database connectivity settings.



4. Copy your new project to your web server. Upload it where **NC_CMS_URL** refers to from **/nc-cms/config.php**. The root of your domain is recommended (**http://www.example.com/nc-cms/** or **http://localhost/nc-cms**).



5. Optionally, if you're using database support, visit **/nc-cms/setup_database_mysql.php** from your server in your web browser.



6. Installation complete!



### Integration with an existing website.



Any web page file will work (**.php**, **.html**, **.htm**). If you would like to use it with an **.html** or **.htm** file, first convert it to **.php** by changing the file extension. (Also remember to change your internal links to **.php** where necessary.)



1. To activate nc-cms on a page, insert the following code before your opening `` tag. It is possible that you may need to change this path depending on where you've uploaded nc-cms.



        



2. To enable "title editing", insert the following code inside your `` tag. **custom_name** can be anything you like. Alphanumeric and underscore characters are supported. We personally recommend a naming convention of page_title (Examples: **home_title**, **about_title**). 



	*TIP:* If you'd like another page to use the same title, use the same **custom_name**.



        Title('custom_name'); ?>



3. Include the CSS used by nc-cms: insert the following code inside of your `` tag.



        



4. When logged into nc-cms, this will enable the control panel to appear. Insert the following code just after your opening `` tag.



        ControlPanel(); ?>



5. The following lines will place editable content areas. These will display any content assigned to the **custom_name**, and when you are logged in, will enable you to edit them. If the assigned content does not exist, a placeholder will be created automatically. Insert these anywhere in between your `` tags.



    These editable content areas come in two flavours: **HTML** and **string**.



    The **HTML** content area is the most common. These areas can contain many paragraphs, images, headers, links and more. 



    Create an HTML area like this:



        ContentHTML('custom_name'); ?>



    The **string** content area is used for single lines of text. When used, these are generally placed inline between the header and paragraph tags themselves as per your convenience. 



    Create a String area like this:



        ContentString('custom_name'); ?>



    Again, **custom_name** can be anything you wish. I personally recommend a naming convention of page_content (Example: home_main, home_sidebar, about_contact, all_copyright etc.).



    *TIP:* If you would like to display the same content across multiple pages, use the same **custom_name**. This is useful for content such as *copyright information*.



6. Login Link (Optional). You may want to place a link on the page for easy access to the nc-cms login page. If this is the case, use the following line of code:



        LoginLink(); ?>



    Or even simpler:



        Login



### Managing Content.



1. Visit the page you would like to edit (you will be re-directed here after login).



2. If you created a login link, use that now. Otherwise you can get to the login page by visiting the **/nc-cms** directory directly (Example: **http://www.example.com/nc-cms**. If the login is a success, you will re-directed to the previous page in editor mode.



3. You will notice two things after successfully logging in: A new control panel will appear at the top of your page. Depending on how many editable content areas you added during your integration, there will be a number of edit buttons scattered throughout your web page. Use these buttons to edit the section associated with it.



4. Edit buttons will direct you to a content editor. Make your changes here and click save. If all has been done correctly, you should be redirected to your live page, with your changes applied.



5. Logout! Logging out is essential for preventing unauthorized changes to your website by anyone using the same computer.



### Upgrading.



You may want to upgrade your version of nc-cms down the road.



1. Back up your settings and content: FTP into your web server. Go to the **/nc-cms** directory and back up your **/nc-cms/config.php** file and **/nc-cms/content** directory.



2. Delete the **/nc-cms** directory and replace it with the new version. Download the latest version of nc-cms. Remove the **/nc-cms** directory that is currently on your web server. Extract and upload the new **/nc-cms** folder to the former installation location on your web server.



3. Re-upload your **config.php** file and **/content** directory to the new nc-cms installation. Replace as necessary.



4. Upgrade complete! You can confirm your update by logging into nc-cms. The version number is displayed in the top-left of the menu bar. Remember, you may need to explicitly clear your browser cache after the update in order to see all of the changes.



### Credits and License.



Designed and maintained by Nathaniel Sabanski of NConsulting.ca. Licensed under the zlib/libpng license.