Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
pitangainnovare authored Jun 4, 2024
1 parent 4fe34a4 commit 407f620
Showing 1 changed file with 25 additions and 1 deletion.
26 changes: 25 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,25 @@
# usage
## SciELO Usage

## Dev Installation

To build and run the application, being at the root of the project, you can follow these steps:

1. `make build compose=local.yml`
2. `make django_makemigrations`
3. `make django_migrate`
4. `make django_createsuperuser`
5. `make up`

After the fifth step, the application should be functional and accessible at http://0.0.0.0:8009/admin

### Additional notes:

* The instructions assume that you have a working installation of Docker and `make`.
* The `make` commands use the `compose` file `local.yml` to start the application containers.
* The `django_makemigrations` and `django_migrate` commands are used to create and apply database migrations.
* The `django_createsuperuser` command is used to create a superuser account for the application.
* The `make up` command starts the application containers in the background.
* The application is accessible at http://0.0.0.0:8009/admin.
* To log in to the admin panel, you will need to use the superuser credentials that you created with the `django_createsuperuser` command.
* The `Log Manager` tool can be used to view log files and manage application configurations.
* To test the application, you will need to add some content, such as a list of collections and configurations.

0 comments on commit 407f620

Please sign in to comment.