diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 31 |
1 files changed, 31 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..f744995 --- /dev/null +++ b/README.md @@ -0,0 +1,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 +``` |
