This is a wiki engine with markdown template. It aims for performances on low and medium scale. It aims to implement ACL, user management, internal linking, internal search, versioning, tagging&listing, and be easy to mod. https://wiki.sceptique.eu
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
Arthur POULET b75f70528d
wip: add acl
2 months ago
config wip: add database with users 2 months ago
db wip: add acl 2 months ago
spec wip: init 2 months ago
src wip: add acl 2 months ago
.drone.yml wip: init 2 months ago
.editorconfig wip: init 2 months ago
.gitignore wip: add database with users 2 months ago
LICENSE wip: init 2 months ago
Makefile wip: add database with users 2 months ago
README.md wip: add some documentation 2 months ago
polywiki wip: add acl 2 months ago
sam.cr wip: add acl 2 months ago
shard.lock wip: init 2 months ago
shard.yml wip: add some documentation 2 months ago

README.md

polywiki

TODO: Write a description here

Installation

# install dependencies
make deps

# make the binary
make release

# setup the database configuration
cp config/database.yml.sample config/database.yml
editor config/database.yml

# initialize the database
make sam db:setup

# setup the wiki base configuration
editor config/application.yml

Update

# roll the new migrations
make sam db:migrate

# make the binary
make release

Usage

TODO: Write usage instructions here

Development

Dependencies

Documentation about software dependencies we use is written in shards.yml

Database

  • We usually generate migration with make sam generate:model ModelName field:type ...
  • Sometimes to alterate existing table also make sam generate:migration MigrationName
  • Entries in the database are modelized following the principes:
    • Index what is often required
    • Don't make too many relations, but don't copy too much data
    • Always try to refuse null values, unless it make sense
    • Validate data on both application and database schema

Contributing

  1. Fork it (https://github.com/Nephos/polywiki/fork)
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request

Contributors