Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
vacaramin authored Dec 8, 2023
1 parent add3e2f commit f04043e
Showing 1 changed file with 27 additions and 42 deletions.
69 changes: 27 additions & 42 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,46 +1,31 @@
# Virtual Horizon
<p align="center">
<img src="https://github.com/vacaramin/Virtual-Horizon/blob/main/frontend/public/transparent-vhs-logo.png?raw=true" alt="Virtual Horizon Logo">
</p>

Welcome to Virtual Horizon, a remote education startup leveraging a React JS frontend and Golang backend. We integrate adaptive learning algorithms, secure APIs, cloud-based databases, and agile methodologies for efficient development. Our platform is hosted on cloud infrastructure to ensure high availability and scalability.

## Setup
## Development
### Local Development
For local development, use the docker-compose-ci.yaml file. This runs all the services directly from the code on your computer.
```console
docker-compose -f docker-compose-ci.yaml up
```
This command starts all services defined in the docker-compose-ci.yaml file.

### Production Environment
For a production environment, use the docker-compose-prod.yaml file. This pulls the latest images of the code from your repository and runs the services.
```console
docker-compose -f docker-compose-prod.yaml up -d
```
This command starts all services in detached mode for production use.## Technologies Used

## Technologies Used
| ![Go](https://img.shields.io/badge/Go-00ADD8?style=for-the-badge&logo=go&logoColor=white) | ![React.js](https://img.shields.io/badge/React.js-61DAFB?style=for-the-badge&logo=react&logoColor=white) | ![Redux RTK](https://img.shields.io/badge/Redux%20RTK-764ABC?style=for-the-badge&logo=redux&logoColor=white) | ![PostgreSQL](https://img.shields.io/badge/PostgreSQL-4169E1?style=for-the-badge&logo=postgresql&logoColor=white) | ![Migration](https://img.shields.io/badge/Migration-000000?style=for-the-badge) | ![Docker](https://img.shields.io/badge/Docker-2496ED?style=for-the-badge&logo=docker&logoColor=white) | ![GitHub Actions](https://img.shields.io/badge/GitHub%20Actions-2088FF?style=for-the-badge&logo=github&logoColor=white) | ![GORM](https://img.shields.io/badge/GORM-0076C5?style=for-the-badge&logo=go&logoColor=white) | ![Gin](https://img.shields.io/badge/Gin-F05032?style=for-the-badge&logo=go&logoColor=white) |
| --- | --- | --- | --- | --- | --- | --- | --- | --- |

## Todo
- WebRTC Implementation for video conferencing
- Code improvements
- Replacing axios with RTK
- Use Dispatch for Notifications

### Pre-Requisites

#### Github SSH key Setup
1. Set up your GitHub SSH key for secure repository access.

#### Go
1. Download Go from [here](https://go.dev/doc/install).
2. Navigate to the tar file directory and run the following commands:
```bash
rm -rf /usr/local/go && tar -C /usr/local -xzf go1.20.7.linux-amd64.tar.gz
export PATH=$PATH:/usr/local/go/bin
```
3. Restart your computer to apply changes.


#### Install Make
```bash
sudo apt install make
```
#### Postgres
Run these commands on the terminal
```bash
sudo apt update
sudo apt install postgresql postgresql-contrib
sudo systemctl start postgresql.service
sudo -i -u postgres
psql
\q
exit
createuser --interactive
```
#### PgAdmin

Credentials
`username: admin`
`Password: helloworld`


# To do
`Dockerizing Whole Application`

0 comments on commit f04043e

Please sign in to comment.