https://github.com/strdr4605/saci.md

https://github.com/strdr4605/saci.md

Last synced: 10 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/strdr4605/saci.md
• Owner: strdr4605
• Created: 2019-05-31T19:08:19.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2023-02-28T20:34:39.000Z (almost 2 years ago)
• Last Synced: 2024-04-18T10:33:03.654Z (8 months ago)
• Language: JavaScript
• Homepage: https://strdr4605.github.io/saci.md
• Size: 9.51 MB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 21
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# saci.md

## Run Project

```sh

npm install

npm start

# in another tab

npm run webpack

```

After you see the webpack compilation succeed (the `npm run webpack` step), open up `build/index.html` (**no server needed!**). Then modify whichever `.re` file in `src` and refresh the page to see the changes.

**For more elaborate ReasonReact examples**, please see https://github.com/reasonml-community/reason-react-example

## Run Project with Server

To run with the webpack development server run `npm run server` and view in the browser at http://localhost:8000. Running in this environment provides hot reloading and support for routing; just edit and save the file and the browser will automatically refresh.

Note that any hot reload on a route will fall back to the root (`/`), so `ReasonReact.Router.dangerouslyGetInitialUrl` will likely be needed alongside the `ReasonReact.Router.watchUrl` logic to handle routing correctly on hot reload refreshes or simply opening the app at a URL that is not the root.

To use a port other than 8000 set the `PORT` environment variable (`PORT=8080 npm run server`).

## Build for Production

```sh

npm run clean

npm run build

npm run webpack:production

```

This will replace the development artifact `build/Index.js` for an optimized version as well as copy `src/index.html` into `build/`. You can then deploy the contents of the `build` directory (`index.html` and `Index.js`).

If you make use of routing (via `ReasonReact.Router` or similar logic) ensure that server-side routing handles your routes or that 404's are directed back to `index.html` (which is how the dev server is set up).

**To enable dead code elimination**, change `bsconfig.json`'s `package-specs` `module` from `"commonjs"` to `"es6"`. Then re-run the above 2 commands. This will allow Webpack to remove unused code.