Skip to content

Commit d58ebd4

Browse files
Fix README
1 parent 9679061 commit d58ebd4

File tree

2 files changed

+6
-33
lines changed

2 files changed

+6
-33
lines changed

.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
public/bundle.js*
2+
deploy/
23

34
# Node
45
node_modules/

README.md

+5-33
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,7 @@
1-
# Fable Minimal App
1+
# Fable Community Resource Finder
22

3-
This is a simple Fable app including an [Elmish](https://elmish.github.io/) counter with as little configuration as possible. If you want to see a more complex app including commonly used F# tools like Paket or Fake, check [the Fulma demo](https://github.com/MangelMaxime/fulma-demo).
3+
Simple Fable app to find resources from the awesome Fable community. If you want to add a resource, please send a PR to edit the `public/community.json` file.
44

5-
## Requirements
6-
7-
* [dotnet SDK](https://www.microsoft.com/net/download/core) 2.1 or higher
8-
* [node.js](https://nodejs.org) with [npm](https://www.npmjs.com/)
9-
* An F# editor like Visual Studio, Visual Studio Code with [Ionide](http://ionide.io/) or [JetBrains Rider](https://www.jetbrains.com/rider/).
10-
11-
## Building and running the app
12-
13-
* Install JS dependencies: `npm install`
14-
* Start Webpack dev server: `npx webpack-dev-server` or `npm start`
15-
* After the first compilation is finished, in your browser open: http://localhost:8080/
16-
17-
Any modification you do to the F# code will be reflected in the web page after saving.
18-
19-
## Project structure
20-
21-
### npm
22-
23-
JS dependencies are declared in `package.json`, while `package-lock.json` is a lock file automatically generated.
24-
25-
### Webpack
26-
27-
[Webpack](https://webpack.js.org) is a JS bundler with extensions, like a static dev server that enables hot reloading on code changes. Fable interacts with Webpack through the `fable-loader`. Configuration for Webpack is defined in the `webpack.config.js` file. Note this sample only includes basic Webpack configuration for development mode, if you want to see a more comprehensive configuration check the [Fable webpack-config-template](https://github.com/fable-compiler/webpack-config-template/blob/master/webpack.config.js).
28-
29-
### F#
30-
31-
The sample only contains two F# files: the project (.fsproj) and a source file (.fs) in the `src` folder.
32-
33-
### Web assets
34-
35-
The `index.html` file and other assets like an icon can be found in the `public` folder.
5+
- Install dependencies: `npm install`
6+
- Develop: `npm start`
7+
- Deploy to Github Pages: `npm run deploy`

0 commit comments

Comments
 (0)