From 8f228f959d17ae59e08d1de4c19d9d6695a82bed Mon Sep 17 00:00:00 2001 From: Vidhu Kant Sharma Date: Wed, 21 Dec 2022 17:51:23 +0530 Subject: Update README --- README.md | 73 +++++++++------------------------------------------------------ 1 file changed, 10 insertions(+), 63 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index c0541f9..19e0304 100644 --- a/README.md +++ b/README.md @@ -1,70 +1,17 @@ -# Getting Started with Create React App +# OpenBills Web -This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app). +Frontend for a libre billing software written in react. OpenBills is geared towards small businesses and is highly biased with my workflow. +There are some innovative features that make generating invoices more convinient, and automates some of the data entry. The defaults are highly biased towards my own workflow but I'm open to suggestions. -## Available Scripts +Currently, there are no installation instructions because I'm not releasing the binaries right now. +To test, clone this repo and also , +in `openbills-web` directory, do `yarn start` or `npm run start`, and in `OpenBills-server` do `go run .` to start the development version. -In the project directory, you can run: -### `yarn start` +# License -Runs the app in the development mode.\ -Open [http://localhost:3000](http://localhost:3000) to view it in your browser. +Licenced under GNU General Public Licence V3 -The page will reload when you make changes.\ -You may also see any lint errors in the console. +GNU GPL License: [LICENSE](LICENSE) -### `yarn test` - -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. - -### `yarn build` - -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. - -### `yarn eject` - -**Note: this is a one-way operation. Once you `eject`, you can't go back!** - -If you aren't satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project. - -Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you're on your own. - -You don't have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn't feel obligated to use this feature. However we understand that this tool wouldn't be useful if you couldn't customize it when you are ready for it. - -## Learn More - -You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started). - -To learn React, 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) - -### `yarn 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) +Copyright (c) 2022 Vidhu Kant Sharma -- cgit v1.2.3