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
• Docs
• Code of Conduct
• License
• Contact

About The Project

TBD

Built With

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

Demo (Stable)

• Editor
  • username: dev@wepublish.ch
  • password: 123
• Website
• API V1
• API Admin

Packages

• @wepublish/api
• @wepublish/editor

Getting Started

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

Prerequisites

• Node v18.x.x
• Docker v19.x.x

Installation

1. Clone the repo

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

2. Install NPM packages

npm i

3. Build project.

npm run build

4a. Test wepublish (the initial admin login is red printed in the log at first startup)

npm run try

4b. Run the project (starts a postgresql with Docker)

npm run dev

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

npm run watch

Or if you want to watch only certain packages:

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

Usage

• Website: http://localhost:4200
• API: http://localhost:4000
• Media Server: http://localhost:4100
• Editor: http://localhost:3000
• Webpack Dev Server: http://localhost:3001
• Postgresql: http://localhost:5432
• PGAdmin: http://localhost:8000

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

Docs

All code documentation lives in the docs folder.

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 dev@wepublish.ch.

License

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

Contact

We.Publish - @WePublish_media - dev@wepublish.ch

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