cerc-io/keycloak-reg-ui
16
0
Fork 0
Code Issues 1 Pull Requests Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Thomas E Lackey 2023-08-17 22:23:04 +00:00
parent 4f2ac7495f
commit 3c44feb4fa
1 changed files with 12 additions and 77 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

89
README.md
View File

@ -1,84 +1,19 @@
# Logster - login/register-page-app
> Simple login/register-page-app created with React js.
Logster is a React app that has a Login, Register and Reset password features. This is just the Front-end of the app, no Back-end.
## Table of contents
* [Functionalities](#functionalities)
* [Technologies](#technologies)
* [Live App](#live-app)
* [Packages & Libraries](#packages-&-libraries)
* [Contributing](#contributing)
* [Support](#support)
* [Final Words](#final-words)
* [License](#license)
## Functionalities
* Login with username and password
* Create an account
* Reset password
## Technologies
* React js
* HTML5
* CSS3
## Live App
To view and test the app you can visit this [link](https://logsterapp.netlify.com/).
## Packages & Libraries
* [react-router-dom](https://www.npmjs.com/package/react-router-dom)
## Contributing
Pull requests are welcome. Please feel free to submit an issue first to discuss what you would like to change.
The process to start is simple, just make sure you have [Node js](https://nodejs.org/en/) installed in your computer.
First you need to go to project's main directory which contains package.json file
```bash
git clone [Repository]
cd [Repository-Directory]
npm install
npm start
## Local
```
or
```bash
git clone [Repository]
$ yarn install
cd [Repository-Directory]
yarn install
yarn start
# Edit `src/App.js` and `src/components/pages/RegisterPage.js` to set
# `basePath` and `apiUrl` and then run:
$ yarn build
$ serve -s build
```
.. happy Coding..!!
## Docker
```
$ docker build -t cerc/keycloak-reg-ui:local .
## Support
Reach out to me at one of the following places!
- Website at <a href="https://izemspot.netlify.com" target="_blank">`izemspot.netlify.com`</a>
- Gmail <a href="mailto:zmr.ilyas@gmail.com" target="_blank">`zmr.ilyas@gmail.com`</a>
## Final Words
If you like the app, please give it a star. It will mean a lot for me :)
## License
- **[MIT license](http://opensource.org/licenses/mit-license.php)**
- Copyright 2019 © <a href="https://izemspot.netlify.com" target="_blank">IZEMSPOT</a>.
# Edit config.yml for your API settings and then run:
$ docker run -d -p 3000:80 -v .:/config cerc/keycloak-reg-ui:local
```