Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wikipendium/wikipendium.no
Compendiums edited as a wiki.
https://github.com/wikipendium/wikipendium.no
css hacktoberfest javascript python wiki
Last synced: 5 days ago
JSON representation
Compendiums edited as a wiki.
- Host: GitHub
- URL: https://github.com/wikipendium/wikipendium.no
- Owner: wikipendium
- License: apache-2.0
- Created: 2013-01-28T20:42:03.000Z (almost 12 years ago)
- Default Branch: main
- Last Pushed: 2021-10-29T18:49:20.000Z (about 3 years ago)
- Last Synced: 2024-05-18T21:53:49.724Z (6 months ago)
- Topics: css, hacktoberfest, javascript, python, wiki
- Language: JavaScript
- Homepage: https://www.wikipendium.no
- Size: 1.6 MB
- Stars: 36
- Watchers: 5
- Forks: 5
- Open Issues: 45
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-starred - wikipendium/wikipendium.no - Compendiums edited as a wiki. (python)
README
wikipendium.no
==============
kompendie-wiki
## Getting started
This is a short guide to setting up the project for developing.
### Dependencies
* python-dev
* pip
* build-essential
These can be installed on ubuntu with:
(as root)$ apt-get install python-dev python-pip build-essential
You also need virtualenv, which can be installed with pip:
(as root)$ pip install virtualenv
Then simply:
```
git clone [email protected]:stianjensen/wikipendium.no.git
cd wikipendium.no
make setup
source venv/bin/activate
make
```
When you've pulled updates, you can run `make` to udpate dependencies and migrate the database.
If you want newrelic reporting in prod, `cp wikipendium/settings/newrelic.ini.example wikipendium/settings/newrelic.ini`, and put the proper newrelic licence key in the .ini file.
#### Setup on Windows
* If you do not have make installed, open Makefile to see what f.ex `make setup` corresponds to. Or get [Make for Windows](http://gnuwin32.sourceforge.net/packages/make.htm).
* pip may fail to install PyCrypto. In that case, download [binaries for Windows](http://www.voidspace.org.uk/python/modules.shtml#pycrypto). You can install pycrypto by running the exe file with easy_install (f.ex `easy_install pycrypto-2.6.win32-py2.7.exe`)
* You may have to install six. Simply run `pip install six`.
#### E-mail sending
Some parts of wikipendium (such as password recovery) relies on e-mail sending.
For this to work, mailgun needs to be set up on the prod server.
```
MAILGUN_ACCESS_KEY = 'ACCESS-KEY'
MAILGUN_SERVER_NAME = 'SERVER-NAME'
```
## Coding style
Wikipendium uses Flake8.
Getting a plugin for your editor is highly recommended.