Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mherman22/ktminv-frontend
https://github.com/mherman22/ktminv-frontend
carbon-design-system jsx reactjs reactjs-components typescript
Last synced: 30 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/mherman22/ktminv-frontend
- Owner: mherman22
- Created: 2022-07-29T10:55:36.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-04-18T13:28:42.000Z (9 months ago)
- Last Synced: 2024-10-16T10:33:01.812Z (3 months ago)
- Topics: carbon-design-system, jsx, reactjs, reactjs-components, typescript
- Language: JavaScript
- Homepage: https://mherman22.github.io/KTMInv-frontend/
- Size: 4.05 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# KTMInv Frontend
This is the frontend (ui) for https://github.com/mherman22/KTMInv \
It was bootstrapped with [Create React App](https://github.com/facebook/create-react-app). I have not used any library in this project (yet).
### Technologies used?
- Reactjs with jsx
- React-router-dom.
- Tailwind Css
### How to run this application?
- clone it onto your machine by running `git clone https://github.com/mherman22/KTMInv-frontend.git`.
- cd into `KTMInv-frontend`
- Open the command prompt or terminal.
- Run `npm install` to install the dependencies.
- Then run `npm start`.
- Open [http://localhost:3000](http://localhost:3000) to view it in your browser.\
The page will reload when you make changes. You may also see any lint errors in the console.
### To change the default port?
- For windows users, go to package.json file and replace [react-scripts start](https://github.com/mherman22/KTMInv-frontend/blob/05b97e64abc5bd904a4451d79e369c16affc5722/package.json#L15) with `"start": "set PORT=portNumberOfYourChoice && react-scripts start"`.
- For Linux users, do the above and replace with `"start": "PORT=portNumberOfYourChoice react-scripts start"` or `"start": "export PORT=portNumberOfYourChoice react-scripts start"`
### How to contribute to this project?
- fork this repository.
- clone it onto your machine by running `git clone https://github.com/mherman22/KTMInv-frontend.git`.
- make your changes and test them to ensure everything perfect.
- create a branch `git checkout -b branch-name`.
- commit your changes to your branch using `git add .` and `git commit -m "commit message"`.
- pull from origin to ensure your local repo is in sync with upstream. use `git pull origin branch-name`
- push your changes using `git push origin branch-name`.
- create a pull request and give it a proper description stating clearly the changes you have added.
### In the project directory, you can run:
- `npm start`: It runs the app in the development mode.\
Open [http://localhost:3000](http://localhost:3000) to view it in your browser.\
The page will reload when you make changes.\
You may also see any lint errors in the console.
- `npm test`: It launches the test runner in the interactive watch mode.\
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
- `npm run build`: It builds the app for production to the `build` folder.\
It correctly bundles React in production mode and optimizes the build for the best performance.\
The build is minified and the filenames include the hashes.\
Your app is ready to be deployed!\
See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
### Learn More
To learn more about React, explore the following links;-
- You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started) and also check out the [React documentation](https://reactjs.org/).
- Code Splitting: This section has moved here: [https://facebook.github.io/create-react-app/docs/code-splitting](https://facebook.github.io/create-react-app/docs/code-splitting).
- Analyzing the Bundle Size: This section has moved here: [https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size](https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size).
- Making a Progressive Web App: This section has moved here: [https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app](https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app).
- Advanced Configuration: This section has moved here: [https://facebook.github.io/create-react-app/docs/advanced-configuration](https://facebook.github.io/create-react-app/docs/advanced-configuration).
- Deployment: This section has moved here: [https://facebook.github.io/create-react-app/docs/deployment](https://facebook.github.io/create-react-app/docs/deployment).
- `npm run build` fails to minify: This section has moved here: [https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify](https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify).
## some screenshots
| Login Screenshot | Register Screenshot |
| ------------- | ------------- |
|  |  |
### Up coming additions
- Handling Authentication and Authorisation
- Home dashboard.
- Dockerising.
- Unit tests.
- E2E tests.
### Contributor(s)
- [mherman22](https://github.com/mherman22)