Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Replace content with short description and building and running instructions.
  • Loading branch information
wkktoria committed Nov 28, 2024
1 parent 977dbf4 commit 3f1bc51
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 6 deletions.
35 changes: 29 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,33 @@
# Edux

> [!WARNING]
> The database host is not running, if demo doesn't work.
![Edux's homepage](docs/images/edux_homepage.png)

[Live demo](https://edux-rht9.onrender.com).
Edux is a simple and intuitive Learning Management System (LMS) that makes it easy to manage and deliver online
learning.

To login as an admin use these credentials:
- username: [email protected]
- password: adminstr0ngp@sw00rd
## Building

**Requirements**

- [Docker](https://www.docker.com/products/docker-desktop)

1. Create .env file providing MySQL database connection details, it should include:
- `PROD_MYSQLDB_HOST`
- `PROD_MYSQLDB_PORT`
- `PROD_MYSQLDB_DATABASE`
- `PROD_MYSQLDB_USER`
- `PROD_MYSQLDB_PASSWORD`
2. Build Docker image: `docker build -t edux .`.
3. Create Docker container: `docker create -p 8081:8081 --env-file .env --name edux edux`.
4. Run the container: ``

## Running

**Requirements**

- [Docker](https://www.docker.com/products/docker-desktop)

1. Create Docker container: `docker create -p 8081:8081 --env-file .env --name edux edux`.
2. Start the container: `docker start -ai edux`.

Application should be started on port `8081`.
Binary file added docs/images/edux_homepage.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 3f1bc51

Please sign in to comment.