Skip to content

Commit

Permalink
docs: update README with setup instructions and prerequisites
Browse files Browse the repository at this point in the history
  • Loading branch information
vincentauger committed Nov 20, 2024
1 parent 1b99b5c commit d12f065
Showing 1 changed file with 35 additions and 0 deletions.
35 changes: 35 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,41 @@ A web-based application to promote open science and track science publications w
For now, we'll use spatie.be's excellent [guidelines](https://spatie.be/guidelines).
Additional guidelines will be added here as we progress.

## Get Started

Before you begin, ensure you have the following prerequisites installed:

- [PHP 8.3](https://www.php.net/) (see [php.net](https://www.php.net/))
- [WSL](https://docs.microsoft.com/en-us/windows/wsl/install) if you are on Windows
- [Redis](https://redis.io/)
- [MySQL](https://www.mysql.com/) (to mimic production, though SQLite can be used for development)

1. Install dependencies:

```bash
composer install
pnpm install
```

2. Set up environment variables:

```bash
cp .env.example .env
php artisan key:generate
```

3. Run database migrations:

```bash
php artisan migrate
```

4. Start the development servers:

```bash
composer run dev
```

## Built With

This repo has both the front end and backend code. The front end is a SPA that consumes the API backend.
Expand Down

0 comments on commit d12f065

Please sign in to comment.