Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/baronfel/giraffe.spark
A giraffe binding for the Spark View Engine
https://github.com/baronfel/giraffe.spark
Last synced: 9 days ago
JSON representation
A giraffe binding for the Spark View Engine
- Host: GitHub
- URL: https://github.com/baronfel/giraffe.spark
- Owner: baronfel
- License: mit
- Created: 2018-09-09T16:51:59.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2018-09-11T03:35:28.000Z (about 6 years ago)
- Last Synced: 2024-10-20T08:56:29.321Z (27 days ago)
- Language: F#
- Size: 214 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Giraffe.Spark
Giraffe.Spark is a view engine binding for the Spark View Engine and the Giraffe web library. It currently only supports full-framework targets because the SparkViewEngine library only supports full-framework targets.
TODOS:
- [ ] discover/compile views at startup
- [ ] find view based on name
- [ ] figure out a nicer way to provide things like `AntiForgeryToken()` from the Nancy bindings (perhaps custom registration of the base view type is enough?)
---
## Builds
MacOS/Linux | Windows
--- | ---
[](https://travis-ci.org/baronfel/Giraffe.Spark) | [](https://ci.appveyor.com/project/baronfel/Giraffe.Spark)
[](https://travis-ci.org/baronfel/Giraffe.Spark/builds) | [](https://ci.appveyor.com/project/baronfel/Giraffe.Spark)
## Nuget
Stable | Prerelease
--- | ---
[](https://www.nuget.org/packages/Giraffe.Spark/) | [](https://www.nuget.org/packages/Giraffe.Spark/)
---
### Building
Make sure the following **requirements** are installed in your system:
* [dotnet SDK](https://www.microsoft.com/net/download/core) 2.0 or higher
* [Mono](http://www.mono-project.com/) if you're on Linux or macOS.
```
> build.cmd // on windows
$ ./build.sh // on unix
```
#### Environment Variables
* `CONFIGURATION` will set the [configuration](https://docs.microsoft.com/en-us/dotnet/core/tools/dotnet-build?tabs=netcore2x#options) of the dotnet commands. If not set it will default to Release.
* `CONFIGURATION=Debug ./build.sh` will result in things like `dotnet build -c Debug`
* `GITHUB_TOKEN` will be used to upload release notes and nuget packages to github.
* Be sure to set this before releasing
### Watch Tests
The `WatchTests` target will use [dotnet-watch](https://github.com/aspnet/Docs/blob/master/aspnetcore/tutorials/dotnet-watch.md) to watch for changes in your lib or tests and re-run your tests on all `TargetFrameworks`
```
./build.sh WatchTests
```
### Releasing
* [Start a git repo with a remote](https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/)
```
git add .
git commit -m "Scaffold"
git remote add origin origin https://github.com/user/MyCoolNewLib.git
git push -u origin master
```
* [Add your nuget API key to paket](https://fsprojects.github.io/Paket/paket-config.html#Adding-a-NuGet-API-key)
```
paket config add-token "https://www.nuget.org" 4003d786-cc37-4004-bfdf-c4f3e8ef9b3a
```
* [Create a GitHub OAuth Token](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/)
* You can then set the `GITHUB_TOKEN` to upload release notes and artifacts to github
* Otherwise it will fallback to username/password
* Then update the `RELEASE_NOTES.md` with a new version, date, and release notes [ReleaseNotesHelper](https://fsharp.github.io/FAKE/apidocs/fake-releasenoteshelper.html)
```
#### 0.2.0 - 2017-04-20
* FEATURE: Does cool stuff!
* BUGFIX: Fixes that silly oversight
```
* You can then use the `Release` target. This will:
* make a commit bumping the version: `Bump version to 0.2.0` and add the release notes to the commit
* publish the package to nuget
* push a git tag
```
./build.sh Release
```
### Code formatting
To format code run the following target
```
./build.sh FormatCode
```
This uses [Fantomas](https://github.com/fsprojects/fantomas) to do code formatting. Please report code formatting bugs to that repository.