https://github.com/convex-dev/convex-web
https://github.com/convex-dev/convex-web
Last synced: 9 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/convex-dev/convex-web
- Owner: Convex-Dev
- Created: 2020-07-14T08:11:50.000Z (almost 6 years ago)
- Default Branch: develop
- Last Pushed: 2025-03-20T01:28:52.000Z (over 1 year ago)
- Last Synced: 2025-04-30T19:49:55.884Z (about 1 year ago)
- Language: Clojure
- Homepage: https://convex.world
- Size: 96.6 MB
- Stars: 16
- Watchers: 6
- Forks: 18
- Open Issues: 40
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
## Configuration
### Secrets
The default configuration - config.edn - requires a `~/.convex/secrets.edn` file.
You can copy the example `secrets.example.edn` and configure the passphrase.
## Development
### Prerequisites
- [Java Development Kit 11](https://adoptopenjdk.net/)
- [Clojure CLI](https://clojure.org/guides/getting_started#_clojure_installer_and_cli_tools)
### App
Install dependencies:
```
npm install
```
Compile CSS:
```
npm run styles:watch
```
Run Shadow CLJS:
```
npm run app:watch
```
### Server
Run REPL with the `dev` alias:
```
clj -A:dev:java-16
```
The `java-16` profile enables VM options required for Java 16+
Start server on port 8080:
```
(go)
```
## Docker Testing
To run convex-web as a local docker container, you will need to do the following.
Build the docker image
```
docker build -t convex-web .
```
Run the docker image
```
docker run --publish 8080:8080 convex-web
```
## Production
### App
Install dependencies:
```
npm install
```
Compile & bundle app:
```
npm run app:release
```
Compile CSS:
```
npm run styles:release
```
### Server
```
bin/run
```
### Create a Linux `systemd` Service
- Copy:
`deployment/convex_web.service` to `/etc/systemd/system/convex_web.service`;
- Enable:
`sudo systemctl enable convex_web`
- Start:
`sudo systemctlm start convex_web`