The source files for doc.inkdrop.info.
.
├── /build/ # The folder for compiled output
├── /node_modules/ # 3rd-party libraries and utilities
├── /components/ # React components
├── /core/ # Core framework
├── /pages/ # React.js-based web pages
│ ├── /manual/ # Manual pages
│ ├── /reference/ # API Reference pages
│ ├── /404.js # Not Found page
│ ├── /500.js # Error page
│ └── /index.js # Top page
├── /static/ # Static files such as favicon.ico etc.
├── /test/ # Unit and integration tests
├── /tools/ # Build automation scripts and utilities
│── app.js # The main JavaScript file (entry point)
│── config.js # Website configuration / settings
│── LICENSE.txt # License file
│── package.json # Dev dependencies and NPM scripts
└── README.md # Project overview
Just clone the repo, install Node.js modules and run npm start:
$ git clone -b master --single-branch git@github.com:inkdropapp/docs.git
$ cd docs
$ npm install
$ npm start
Then open http://localhost:3000/ in your browser.
The unit tests are powered by chai and mocha.
$ npm test
$ npm run deploy # Deploys the project to GitHub PagesAlternatively, you can build a production release to manually deploy to S3, Firebase, Netlify, and other static hosts. Simply run the command below and copy the generated build folder to your static host.
$ npm run build release # Build production release You can always fetch and merge the recent changes from this repo back into your own project:
$ git checkout master
$ git fetch react-static-boilerplate
$ git merge react-static-boilerplate/master
$ npm installMade with ♥ by Konstantin Tarkus (@koistya) and contributors | MIT License