aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: f744995a4149a6d0ccb53b47bce64f5891ed4301 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
# react-go-forum 

A self-contained mobile-first forum written in React and Go.

## Dependencies

- [npm](https://npmjs.com) : npm is a package manager for the JavaScript programming language.
- [Go](https://go.dev) : Go is a statically typed, compiled programming language.

## Building from Source

First, clone the repository using Git.
```console
    $ git clone https://salvestromartin.com:443/nJ3ahxac/react-go-forum.git
```                                                                             

Then compile from source via npm after moving into the project directory.

```console                                                                      
    $ cd ./react-go-forum
    $ npm update
```

## Usage

A helper script has been provided which compiles the React and Go code and runs
the server.

```console                                                                      
    $ ./run_server.sh
```