https://github.com/cdilga/erinome-server
Erinome Server
https://github.com/cdilga/erinome-server
Last synced: 3 months ago
JSON representation
Erinome Server
- Host: GitHub
- URL: https://github.com/cdilga/erinome-server
- Owner: cdilga
- Created: 2019-06-02T04:16:09.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2022-12-10T00:34:57.000Z (over 3 years ago)
- Last Synced: 2023-06-08T00:35:13.789Z (about 3 years ago)
- Language: F#
- Size: 1.64 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# SAFE Template
This template can be used to generate a full-stack web application using the [SAFE Stack](https://safe-stack.github.io/). It was created using the dotnet [SAFE Template](https://safe-stack.github.io/docs/template-overview/). If you want to learn more about the template why not start with the [quick start](https://safe-stack.github.io/docs/quickstart/) guide?
## Install pre-requisites
You'll need to install the following pre-requisites in order to build SAFE applications
* The [.NET Core SDK](https://www.microsoft.com/net/download)
* [FAKE 5](https://fake.build/) installed as a [global tool](https://fake.build/fake-gettingstarted.html#Install-FAKE)
* The [Yarn](https://yarnpkg.com/lang/en/docs/install/) package manager (you an also use `npm` but the usage of `yarn` is encouraged).
* [Node LTS](https://nodejs.org/en/download/) installed for the front end components.
* If you're running on OSX or Linux, you'll also need to install [Mono](https://www.mono-project.com/docs/getting-started/install/).
## Work with the application
To concurrently run the server and the client components in watch mode use the following command:
```bash
fake build -t Run
```
You can use the included `Dockerfile` and `build.fsx` script to deploy your application as Docker container. You can find more regarding this topic in the [official template documentation](https://safe-stack.github.io/docs/template-docker/).
## SAFE Stack Documentation
You will find more documentation about the used F# components at the following places:
* [Saturn](https://saturnframework.org/docs/)
* [Fable](https://fable.io/docs/)
* [Elmish](https://elmish.github.io/elmish/)
* [Fulma](https://fulma.github.io/Fulma/)
If you want to know more about the full Azure Stack and all of it's components (including Azure) visit the official [SAFE documentation](https://safe-stack.github.io/docs/).
## Troubleshooting
* **fake not found** - If you fail to execute `fake` from command line after installing it as a global tool, you might need to add it to your `PATH` manually: (e.g. `export PATH="$HOME/.dotnet/tools:$PATH"` on unix) - [related GitHub issue](https://github.com/dotnet/cli/issues/9321)