mouazdk / wepublish

we.publish

Open Source Headless CMS for Publishers and News Rooms


View Demo · Report Bug · Request Feature

Table of Contents

• About the Project
  • Built With
• Demo
• Packages
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Troubleshooting
• Contributing
• Code of Conduct
• License
• Contact

About The Project

TBD

Built With

• Node.js
• GraphQL
• React
• TypeScript
• 💚

Demo

• Editor
  • username: [email protected]
  • password: 123
• Website
• API

Packages

• @wepublish/api
  • DB Adapter:
    • @wepublish/api-db-mongodb
  • Media Adapter:
    • @wepublish/api-media-karma
• @wepublish/editor
• @wepublish/oauth2

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

• Node v12.x.x
• Yarn v1.17.x
• Docker v19.x.x

Installation

1. Clone the repo

git clone https://github.com/wepublish/wepublish.git

2. Install NPM packages

yarn install

3. Setup and build project. The setup command will create the necessary .env files.

yarn setup && yarn build

4. Run the project (starts a mongoDB with Docker)

yarn dev

If you rather wish to run docker-compose separately you can just watch the packages via:

yarn watch

Or if you want to watch only certain packages:

yarn run-p watch:api watch:api-example watch:editor

Usage

• API: http://localhost:4000
• Media Server: http://localhost:4001
• Editor: http://localhost:3000
• Webpack Dev Server: http://localhost:3001
• MongoDB: http://localhost:27017

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated. A good place to start is with an issue that has the label good first issue.

1. Fork the Project
2. Create your Feature Branch (git checkout -b f/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin f/AmazingFeature)
5. Open a Pull Request

Code of Conduct

We.publish is dedicated to building a welcoming, diverse, safe community. We expect everyone participating in the we.publish community to abide by our Code of Conduct. Please read it. Please follow it.

Troubleshooting

If you encounter problems you can check our FAQ or write us [email protected].

License

Distributed under the MIT License. See LICENSE for more information.

Contact

We.Publish - @WePublish_media - [email protected]

Website: https://www.wepublish.ch/