Commit 58557e97 authored by Corentin Mors's avatar Corentin Mors
Browse files

Rename project and clean Readme

parent 24081751
# ExpressJS Starter Kit
This project suggest a MVC (model - view - controller) architecture for an ExpressJS project.
It uses MongoDB to store data as well as Nunjucks for templating.
# X-Cockpit
> A cockpit for your next missions
## Project structure
......@@ -13,6 +11,8 @@ It uses MongoDB to store data as well as Nunjucks for templating.
|-- models
|-- db.js (to connect to database)
|-- users.js (define users contenttype)
|-- routes
|-- index.js (specify routes for the app)
|-- controllers
|-- index.js (for homepage)
|-- users.js (for users contenttype)
......@@ -40,7 +40,7 @@ Go into root folder and enter the following line in your terminal :
Install gulp (and associated components) :
`npm install --global gulp-cli gulp-rename gulp-clean-css gulp-minify`
`npm install --global gulp gulp-cli gulp-rename gulp-clean-css gulp-minify`
## Launch project
......@@ -58,8 +58,7 @@ Your project is accessible at [localhost:3000](http://localhost:3000).
## About design
The administrative panel template is from [Ad.min](https://github.com/Mikescops/ad.min) which is a minimal admin template.
<to be completed>
## Various documentation
......@@ -69,16 +68,3 @@ The administrative panel template is from [Ad.min](https://github.com/Mikescops/
- GulpJS (development automation) : https://gulpjs.com/
- FontAwesome (icons font) : https://fontawesome.com/icons
- Kacole2's skeleton (inspiration of this project) : https://git.io/fxQXK
## Contributing
Feel free to contribute to this project, fork and pull request your ideas.
Don't include work that is not open source or not from you.
## Authors
| [![twitter/mikescops](https://avatars0.githubusercontent.com/u/4266283?s=100&v=4)](http://twitter.com/mikescops "Follow @mikescops on Twitter") |
|---|
| [Corentin Mors](https://pixelswap.fr/) |
\ No newline at end of file
{
"name": "expressjs-starter-kit",
"name": "X-Cockpit",
"version": "0.0.1",
"description": "A starter kit to kickstart your expressjs projects.",
"description": "A cockpit for your next missions",
"dependencies": {
"body-parser": "^1.10.2",
"cookie-parser": "~1.3.3",
......
......@@ -7,7 +7,7 @@
<meta name="author" content="">
<link rel="icon" href="favicon.ico">
<title>{% if title %}{{ title }} - StarterKit{% else %}Dashboard - StarterKit{% endif %}</title>
<title>{% if title %}{{ title }} - X-Cockpit{% else %}Dashboard - X-Cockpit{% endif %}</title>
<!-- Bootstrap core CSS -->
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/4.0.0/css/bootstrap.min.css" integrity="sha384-Gn5384xqQ1aoWXA+058RXPxPg6fy4IWvTNh0E263XmFcJlSAwiGgFAW/dAiS6JXm" crossorigin="anonymous">
......@@ -25,7 +25,7 @@
<!-- Sidebar -->
<nav id="sidebar">
<div class="sidebar-header">
<h3>DashExplorer</h3>
<h3>X-Cockpit</h3>
</div>
<ul class="list-unstyled components">
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment