Mirrors
/
Matterwiki
mirror of https://github.com/Matterwiki/Matterwiki.git
2
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
A simple and beautiful wiki for teams
You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
95 Commits
24 Branches
4 Tags
5.5 MiB
JavaScript 81.5%
CSS 16.5%
HTML 0.9%
Python 0.9%
Dockerfile 0.2%
 
 
 
 
 
refactor
new-editor-xp
oauth
package-upgrade-all
pagination
redesign
redux
models-bug-fixes
models-bug-fixes-krishna
redux-yay-fun
master
react-router/upgrade
directory_structure/refactor
v0.3.0
tests
bug-fix
api
new-design
german-translation
design-fixes
chinese-translation
demo-app
knowledge-search
markdown
v0.2.0
v0.2.1
v0.2.2
v0.2.3
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '4032e96e47'
${ noResults }
Go to file
Nishant Arora 4032e96e47 Merge branch 'master' of github.com:matterwiki/matterwiki 8 years ago
api Article history order fix 8 years ago
client Fixed the article history render issue 8 years ago
db Tracking all folders now. db folder bug fix 8 years ago
migrations Added what changed column to articles and archives 8 years ago
models Created users. GET all users and create user (POST) endpoint 8 years ago
.babelrc Added webpack, babel and react. Basic client setup 9 years ago
.gitignore Added babel-core to dependency 8 years ago
API.md Added API documentation 8 years ago
LICENSE Initial commit 9 years ago
README.md Updated README with images 8 years ago
bookshelf.js Added bookshelf.js 9 years ago
config.js Removed config.js from gitignore 8 years ago
db.js Installed knex and built a basic create article endpoint 9 years ago
index.js Added user setup 8 years ago
install.js Installed knex and built a basic create article endpoint 9 years ago
knexfile.js Installed knex and built a basic create article endpoint 9 years ago
misc.js Changed default timezone for database to use local time. Created a function for same 8 years ago
package.json Added directory to commands for better cross platform compatibility 8 years ago
response_structure_example.json Added the response strucutre guideline 8 years ago
webpack.config.js Added webpack, babel and react. Basic client setup 9 years ago

README.md

People use it to store documentation, notes, culture guidelines, employee onboarding content and everything else they want to.

Setup Instructions:

  1. Clone this repository git clone http://github.com/matterwiki/matterwiki
  2. Run npm install
  3. Edit config.js (present in the project root) and change the auth_secret value with any secret phrase. NOTE: This phrase will be used to encode and decode your access tokens. Keep it safe and private
  4. run npm run build
  5. run node index
  6. Head to yoururl.com/#/setup and create the Admin account.

Replace yoururl.com with your URL. If you're running locally, replace with localhost:5000 7. Login with your new admin account and head to the Admin dashboard. 8. Create topics and add users to your Wiki.

Under the hood

Matterwiki uses a Node.js API with a React.js front-end and Sqlite3 for the database.

As the app is built atop a JSON API, it is simple to integrate your Wiki with your mobile app or blog. For more, read the API documentation.

Like it?

⭐ this repo

Found a bug?

Raise an issue!

Want to contribute?

We welcome all kinds of contributions. It doesn't matter if it's a grammar fix, or some refactoring, or an even an entire UI overhaul. So help us improve Matterwiki for everyone.