relax - GitLite

KO | EN

gitlite — search

#hacktoberfest #react #ai #android #rust #deep-learning #linux #docker #java #awesome-list #pytorch #mcp #openai #open-source

relax

(★ 8,096)

New generation CMS on top of React, Redux and GraphQL

File Explorer

Download Latest Version (.zip)

- file-mock.js
- style-mock.js
- - Dockerfile
  - nginx.conf
- docker-compose-common.yml
- docker-compose-staging.yml
- docker-compose.yml
- - change-log.md
  - index.md
- .gitignore
- .npmignore
- _config.yml
- package.json
- readme.md
- yarn.lock
- - admin.js
  - auth.js
  - public.js
- - index.js
  - logger.js
  - migrate.js
  - schema.js
- .gitempty
- .gitignore
- - webpack.browser.config.js
  - webpack.node.config.js
- - webpack.config.js
- - webpack.config.js
.babelrc
.dockerignore
.eslintrc
.gitignore
.npmignore
.relaxrc.sample
.travis.yml
app.js
config.js
Dockerfile
LICENSE
package.json
README.md
ROADMAP.md
yarn.lock

# Installation Guide

1. Get the code

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

Downloads the entire project code from GitHub to your computer.

cd relax

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Docker Desktop Needed to build and run containers. Install it and keep it running in the background.

docker compose -f docker/docker-compose.yml up -d --build

Runs the command against the services defined in the compose file.

✅ Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

3. Node.js

Easy

Prerequisites

Git Needed to download the project code from GitHub.
Node.js Node.js must be installed to use npm. The LTS version is recommended.

yarn

Downloads and installs the libraries listed in package.json.

yarn build

Builds optimized production files.

yarn start

Starts the development/run server.

✅ After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

**IMPORTANT NOTE:** This project is no longer maintained or active. In the meantime we've started a simillar but different project that we felt was lacking and should exist, a professional tool for web developers and designers, a Unity for the web. After more than 4 years in the making we've now launched on [ProductHunt](https://www.producthunt.com/posts/clutch-3). Clutch is a low code tool that streamlines a professional team workflow and allows them to move together and faster. Go check it out and join us in our [community slack](https://join.slack.com/t/clutch-community/shared_invite/zt-s33mb7is-sC_8Ruk31n~bO~_PCTPa7Q), eager to hear everyone's feedback and thoughts. The tool is free to use!

What is Relax
-------

Relax is a powerful new generation CMS on top of
[React](https://facebook.github.io/react/) and [Node.js](https://nodejs.org/en/)
which aims for a better way of building websites.

It features a live page builder based on components and a smart and easy way of
binding dynamic data to them.

Our goal with Relax is to update the world with a new standard, having as the basic premise that anyone should be able to create a website without having to code.

We're currently working on releasing the beta version which should come up in December. If you want to collaborate in the meantime or just say anything join us at [Relax Slack](http://slack-relax.herokuapp.com/).

Relax isn't yet ready for production, stay tuned for releases, beta version will come soon. You can see what we're working on [here](https://github.com/relax/relax/projects/1) and what's missing in the [beta milestone](https://github.com/relax/relax/milestone/1).

Installation
-------

### Dependencies

Relax uses [sharp](https://github.com/lovell/sharp) to resize images.
If you're using OS X and have libvips installed globally, e.g. via brew,
it may cause problems with sharp's compilation. You may need to uninstall
via `brew remove libvips`. See https://github.com/lovell/sharp/issues/602
for more information.

You'll also need [`yarn`](https://yarnpkg.com) and [MongoDB](https://www.mongodb.org/).

### How to Relax

Since we are yet to tag our first release, git clone this repository and run the following commands:

```bash
yarn
yarn build
yarn start
```

By default the application runs at port `8080`. Go ahead and visit
`http://localhost:8080/admin/init`, here you can setup the first user and you're ready to relax.

### Configuration

To configure the application you can use a `.relaxrc` file. You can place it
next to the application, on any parent folder, in your `HOME` folder, etc.

You can find a sample with the default values [here](.relaxrc.sample).

Contributing
-------

### Build and start

#### Development

While in development it's convenient to keep your application running while
watching for changes, for that you can run `yarn dev`.

The application will automatically restart when needed and keep your bundles
up to date.

#### Production

To build your assets ready to go for production run `yarn build` and `yarn start` to start the application.

##### With Docker

To use our latest docker image you just have to have MongoDB running on a
different container and link it to Relax.

To start MongoDB in the background you can run  `docker run -d --name mongo mongo`.
Afterwards run `docker run -p 8080:8080 --link mongo -it relax/relax` to start
Relax on `http://localhost:8080`.

For more information about Docker please check their
[documentation](https://docs.docker.com/).

License
-------

Relax is [GPL-3 licensed](LICENSE).

Troubleshooting
---------------

Please create [an issue](https://github.com/relax/relax/issues/new).