Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/sofyasher/ships


https://github.com/sofyasher/ships

Last synced: 10 days ago
JSON representation

Awesome Lists containing this project

README

        

# Ships

## Running
For running the app locally do the following steps:
1. Make sure, you have installed [Node JS + npm](https://nodejs.org/en/download) and [Yarn](https://classic.yarnpkg.com/lang/en/docs/install) first.
2. In the project directory run `yarn` to install dependencies.
3. In the project directory run `yarn start`.
4. Open `http://localhost:3000/` in your browser.

## Deployment
1. Make sure, you have installed [Node JS + npm](https://nodejs.org/en/download) and [Yarn](https://classic.yarnpkg.com/lang/en/docs/install) first.
2. In the project directory run `yarn` to install dependencies.
3. In the project directory run `yarn build`.
4. Copy the content of `/build` folder and upload it to your hosting. You will probably need to copy the `/.htaccess` configuration to your hosting for correct routing too.

## Testing
1. In the project directory run `yarn test`.
2. To see the generated code coverage report, go to the folder `/coverage/lcov-report` and open `index.html` in your browser

You can try the app on https://ships.sherstneva.cz.