README.md

Mamute QA

Status of Project

This project is a fork from the original Mamute code, with the goal to use Spring Boot as the web framework in order to continue the project. The database layer was converted to Liquibase, but the controllers and the views have not been converted.

As I have limited time to work on this fork of Mamute, you should consider this project dormant. It can be continued in the future if interest generates around it.

Related Projects

The manmosu project completely re-implemented Mamute in Scala with the Play Framework and continued adding features. Make sure you check it out.

Requirements

This project makes use of the following technologies to simplify setup:

• Node.js
• npm
• Docker CE
• Docker Compose

MySQL database

First of all, you need to setup a MySQL database. The default database configuration is defined in docker-compose.yml, under the db service.

Using Docker Compose, run your MySQL database:

docker-compose up -d

To run Mamute

Using Spring Boot Maven Plugin

Once you have your database started, you can start Mamute with:

mvn spring-boot:run

You can then access Mamute at http://localhost:8080.

Using docker-compose (latest release)

To start an instance of the latest Mamute release and its dependencies:

cd docker
docker-compose up --build

Then you can access Mamute on http://localhost:80.

Using a compiled war file (latest release)

1. Download the war of the latest version at http://www.mamute.org
2. Unpack it to a folder named yourproject/mamute
3. Run it by executing the bash script mamute/run.sh
4. If everything worked, you are free to customize mamute folder as you want to!

Using git + maven:

1. Clone the repository from github
2. Install node and npm
3. Run npm install
4. Run npm install -g grunt-cli
5. Run ./scripts/mvn-package.sh
6. Make a copy of mamute/target/mamute-1.0.0-SNAPSHOT to yourproject/mamute
7. Run it by executing the bash script mamute/run.sh
8. If everything worked, you are free to customize mamute folder as you want to!

To contribute with mamute:

1. Fork the repository from github
2. Clone the fork
3. Install node and npm
4. Run npm install
5. Run npm install -g grunt-cli
6. Run MamuteApplication.java to start mamute
7. Develop and do your pull request

FAQ

• How to setup an instance

• How can I boot Mamute in a production environment?

• How can I configure ad banners in my site?

• How can I configure the system to activate/deactivate some feature?

• How can I configure the system to allow/disallow the creation of tags by common users?

• Is it possible to delete inappropriate questions?

• How can I update mamute in my project?

• What are the basic CSS classes to customize Mamute?

Questions?

Send your questions to mamute meta.

Or to our mail-list: [email protected]