Skip to content

Commit

Permalink
Updated Readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
vimal-m authored Oct 14, 2021
1 parent 89de6d0 commit 7729cc2
Showing 1 changed file with 12 additions and 3 deletions.
15 changes: 12 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,18 @@
# Acharya
Acharya Machine Teaching Platform
A Data Centric MLOps tool for your Named Entity Recognition projects.

# Download
Download the acharya binary latest release for your system.

# Initial Run and Setup
Installation and Setup for Acharya is not required, Acharya detects it running for the first time and runs the initial setup when run for the first time.
To start Acharya type the following command
To start Acharya type the following command in a terminal/command prompt
It is recommended to create a separate folder to run acharya. Acharya will create a data folder and a temp folder to store its data.

On *sh shells
```bash
#copy the downloaded file to the newly created acharya folder and run the following commands.
chmod +x acharya
./acharya
```

Expand All @@ -18,7 +21,13 @@ On Powershell and COMMAND in Windows
acharya.exe
```

Follow the on screen instructions to configure the SSL certificates required for encryption.
Acharya will generate a password for the default user admin@localhost

The UI will be accessible at http://localhost:3000

Login to the UI with admin@localhost as the username and the password displayed on the terminal/command prompt screen.

It is recommended that the users change this password from the UI

# Using Acharya
Login to the Acharya UI using a web-browser and access the URL seen in the output of the above command. The default URL would be https://localhost:3000
Expand Down

0 comments on commit 7729cc2

Please sign in to comment.