The Wiki database made by cavers for cavers!

Current production version is available here

Software requirement:

• NodeJS (min v8)
• NPM (min 4.1.2)
• Git client (see Git usage for configuration)
• Docker
• SailsJS (min v1)
• Grunt

Clone the project on your computer:

> git clone https://github.com/GrottoCenter/Grottocenter3.git

The demonstration deployment aims to launch locally an instance of Grottocenter to demonstrate its features.

Start the project:

> ./deployDemo.sh

Then go to homepage Or access to API documentation for example.

The development deployment aims to launch locally all the tools needed for the Grottocenter development.

Start the project:

> ./deployDev.sh
> npm install

Finally, run the server with live-reloading using:

> npm run start-hot

Run tests:

> npm run test

Check code coverage:

> npm run coverage

For more details, read the installation guide

Caver's community needs YOU!

Yon can also join us on Slack! (using the QR-code above)

~~For more details, read the development guide

Grottocenter is evolving, its deployment is now based on AWS services. To help the usage of deployed services, we have put in place the following documentation :

• Deployment of the MySQL database on Amazon RDS : https://docs.google.com/document/d/1nmfGdScWYBWa91L0SRd7LrH5XK_DQKbkGMtVdDQlmgg/edit?usp=sharing
• Deployment of the Grottocenter3 application on EC2 : https://docs.google.com/document/d/1h8cdmlkZJG5SANKLfQQpOR1kNjMQiSKqb-N-LhM1Zlk/edit?usp=sharing
• Creation and configuration of the Lightsail server : https://docs.google.com/document/d/1hRB9sJ6gXm2nrepli0ipBozq4agg36qQaQCSicxkxQk/edit?usp=sharing
• Deployment of ElasticSearch and Logstash on Lightsail : https://docs.google.com/document/d/1ZarlIOUUWfZvo3jOQ28w8NVA9q9GmK9dIUONhkUw7ZA/edit?usp=sharing

Storybook is used to develop in isolation UI component. It can be start independently with npm run storybook

This project follows the conventional commit specification. It uses commitlint to enforce conventional commit messages.

To prevent bad commit and push, we use the Git hooks Husky

Husky is used to:

• Verify if the commit name use the conventional commit specification
• Do a lint-staged

The commit linter accepts the following types:

• feat: Adds a new feature to the application
• tech: Adds a new technical feature to the application (ex: a new reusable component). Neither fixes a bug nor adds a feature
• refactor: Refactor a current implementation without adding a new feature or fixing a bug
• improvement: Improve a current implementation without adding a new feature or fixing a bug
• fix: A bug fix
• chore: Changes to the build process or auxiliary tools and libraries such as documentation generation
• docs: Documentation only changes
• style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
• test: Adding missing or correcting existing tests
• revert: Reverts a previous work

GNU Affero General Public License v3.0