https://github.com/alevalv/retipy-react

React ui for retipy
https://github.com/alevalv/retipy-react

Last synced: 23 days ago
JSON representation

React ui for retipy

• Host: GitHub
• URL: https://github.com/alevalv/retipy-react
• Owner: alevalv
• License: gpl-3.0
• Created: 2018-04-11T13:50:41.000Z (almost 7 years ago)
• Default Branch: typescript
• Last Pushed: 2019-05-06T03:59:47.000Z (over 5 years ago)
• Last Synced: 2024-11-03T11:42:14.396Z (2 months ago)
• Language: TypeScript
• Homepage: https://retipy.avaldes.co
• Size: 2.4 MB
• Stars: 0
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
retipy-react

============

[![Build Status](https://travis-ci.org/alevalv/retipy-react.svg?branch=master)](https://travis-ci.org/alevalv/retipy-react)

retipy-react is part of the [retipy](https://github.com/alevalv/retipy) project.

UI implementation that relies on [retipy-rest](https://github.com/alevalv/retipy-rest)

REST api to provide a good UX when using retipy.

This project was done using Typescript + React, with the [material-ui](http://material-ui.com/) UI

components.

Building and Testing locally

----------------------------

Install [yarn](https://yarnpkg.com/) in your machine.

Run `yarn install` to fetch all project dependencies (this can take a while).

To test your changes in a local server run `yarn start`.

Building the docker image

-------------------------

Run the following command in the root folder of the project:

```sh

docker build --rm -f "docker/Dockerfile" -t retipy-ui:latest .

```

You can start your created image with: `docker run -it -p 80:80 retipy-ui:latest`. It will map

the server to the port 80 of your machine, switch the -p second 80 to the desired port if this is

an issue.

Automatic builds are available in docker hub as `alevalv/retipy-ui`.

License

-------

retipy-react is free software: you can redistribute it and/or modify

it under the terms of the GNU General Public License as published by

the Free Software Foundation, either version 3 of the License, or

(at your option) any later version.