/veaos

Veaos is a free open source Q&A and knowledge management platform

Primary LanguageTypeScriptMIT LicenseMIT

Veaos

Veaos is a free open source Q&A and knowledge management platform
Explore the docs »

Report Bug · Request Feature

Gitter chat

About The Project

Veaos is a Q&A/knowledge base platform written in MERN stack (MongoDB, Express.js, React, and Node.js). The motivation of this project is to give organizations the ability to set up their own Q&A and knowledge platform for the employees, so they can share knowledge between them by asking questions/writing docs, and collect it for future applications.

Veaos can run everywhere - easily by installing Docker on your target server and following the instructions below.

Built With

Veaos is written in MERN stack (MongoDB, Express.js, React, and Node.js), using some awesome other open-source projects. the main ones will be described in the section, but there are much more that you can find out in the package.json

Getting Started

In this section, you can find out how to set up Veaos, both for production environment and for development environment.

Development

Using NPM and Lerna

npm install  
lerna run dev --stream  

Using Docker Compose

docker-compose -f docker-compose.dev.yml up --build  

Production

Using Docker Compose

docker-compose run --build  

Contributing

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.
Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated ❤️.
you can learn more about how you can contribute to this project in the contribution guide.

License

This repository is available under the MIT License.