diff options
| -rw-r--r-- | LICENCE | 21 | ||||
| -rw-r--r-- | README.md | 72 | ||||
| -rw-r--r-- | server/main.go | 11 | ||||
| -rw-r--r-- | src/components/App.js | 8 | ||||
| -rw-r--r-- | src/components/BillingPage.js | 8 | ||||
| -rw-r--r-- | src/components/Display/Display.scss | 8 | ||||
| -rw-r--r-- | src/components/Display/DisplayItem.js | 8 | ||||
| -rw-r--r-- | src/components/Display/Form.css | 0 | ||||
| -rw-r--r-- | src/components/Display/ItemsDisplay.js | 8 | ||||
| -rw-r--r-- | src/components/Display/SummaryDisplay.js | 8 | ||||
| -rw-r--r-- | src/components/Form/AddNewItemForm.js | 8 | ||||
| -rw-r--r-- | src/components/Form/Form.scss | 8 | ||||
| -rw-r--r-- | src/components/Form/MetaInfoForm.js | 8 | ||||
| -rw-r--r-- | src/components/Header/Header.js | 8 | ||||
| -rw-r--r-- | src/components/Header/Header.scss | 8 | ||||
| -rw-r--r-- | src/index.js | 8 | ||||
| -rw-r--r-- | src/styles/global.scss | 8 |
17 files changed, 142 insertions, 66 deletions
@@ -0,0 +1,21 @@ +The MIT Licence (MIT) + +Copyright (C) 2021 Vidhu Kant Sharma + +Permission is hereby granted, free of charge, to any person obtaining a +copy of this software and associated documentation files (the “Software”), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or +sell copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FO A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY LAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. @@ -1,70 +1,10 @@ -# Getting Started with Create React App +# OpenBills -This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app). +OpenBills is a very simple browser based invoicing software hosted locally and meant for use with standalone computers. +It's ideal for small businesses and is meant to be customizable and easy to use. +So everyone from a computer newbie and a power user can benifit from it. -## Available Scripts +The front end is written in react.js and back end is written in Go. +The backend is a single executable that you run to start the app and then use the app in the browser by going to localhost:8080 -In the project directory, you can run: -### `npm start` - -Runs the app in the development mode.\ -Open [http://localhost:3000](http://localhost:3000) to view it in the browser. - -The page will reload if you make edits.\ -You will also see any lint errors in the console. - -### `npm 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. - -### `npm run 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. - -### `npm run 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) - -### `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) diff --git a/server/main.go b/server/main.go index 2a02269..544f292 100644 --- a/server/main.go +++ b/server/main.go @@ -1,3 +1,14 @@ +/* + * OpenBills - Self hosted browser app to generate and keep track of simple invoices + * Version - 0 + * Licensed under the MIT license - https://opensource.org/licenses/MIT + * + * Copyright (c) 2021 Vidhu Kant Sharma +*/ + +// backend for OpenBills +// currently HIGHLY under development + package main import ( diff --git a/src/components/App.js b/src/components/App.js index 62cc15c..ceed8bd 100644 --- a/src/components/App.js +++ b/src/components/App.js @@ -1,3 +1,11 @@ +/* + * OpenBills - Self hosted browser app to generate and keep track of simple invoices + * Version - 0 + * Licensed under the MIT license - https://opensource.org/licenses/MIT + * + * Copyright (c) 2021 Vidhu Kant Sharma +*/ + import React from "react"; import Header from "./Header/Header"; import BillingPage from "./BillingPage"; diff --git a/src/components/BillingPage.js b/src/components/BillingPage.js index 1f42bf0..7f97b32 100644 --- a/src/components/BillingPage.js +++ b/src/components/BillingPage.js @@ -1,3 +1,11 @@ +/* + * OpenBills - Self hosted browser app to generate and keep track of simple invoices + * Version - 0 + * Licensed under the MIT license - https://opensource.org/licenses/MIT + * + * Copyright (c) 2021 Vidhu Kant Sharma +*/ + import React, { useState, useEffect } from "react"; import axios from "axios"; diff --git a/src/components/Display/Display.scss b/src/components/Display/Display.scss index 7754eb5..d86f4e9 100644 --- a/src/components/Display/Display.scss +++ b/src/components/Display/Display.scss @@ -1,3 +1,11 @@ +/* + * OpenBills - Self hosted browser app to generate and keep track of simple invoices + * Version - 0 + * Licensed under the MIT license - https://opensource.org/licenses/MIT + * + * Copyright (c) 2021 Vidhu Kant Sharma +*/ + @import "../../styles/theme"; .ItemsDisplay, diff --git a/src/components/Display/DisplayItem.js b/src/components/Display/DisplayItem.js index 4bd1b97..8fe6d9a 100644 --- a/src/components/Display/DisplayItem.js +++ b/src/components/Display/DisplayItem.js @@ -1,3 +1,11 @@ +/* + * OpenBills - Self hosted browser app to generate and keep track of simple invoices + * Version - 0 + * Licensed under the MIT license - https://opensource.org/licenses/MIT + * + * Copyright (c) 2021 Vidhu Kant Sharma +*/ + import React from "react"; import "./Display.css"; diff --git a/src/components/Display/Form.css b/src/components/Display/Form.css deleted file mode 100644 index e69de29..0000000 --- a/src/components/Display/Form.css +++ /dev/null diff --git a/src/components/Display/ItemsDisplay.js b/src/components/Display/ItemsDisplay.js index bdf1a40..c8aeb76 100644 --- a/src/components/Display/ItemsDisplay.js +++ b/src/components/Display/ItemsDisplay.js @@ -1,3 +1,11 @@ +/* + * OpenBills - Self hosted browser app to generate and keep track of simple invoices + * Version - 0 + * Licensed under the MIT license - https://opensource.org/licenses/MIT + * + * Copyright (c) 2021 Vidhu Kant Sharma +*/ + import React from "react"; import "./Display.css"; import DisplayItem from "./DisplayItem"; diff --git a/src/components/Display/SummaryDisplay.js b/src/components/Display/SummaryDisplay.js index 2515df8..5cdcc93 100644 --- a/src/components/Display/SummaryDisplay.js +++ b/src/components/Display/SummaryDisplay.js @@ -1,3 +1,11 @@ +/* + * OpenBills - Self hosted browser app to generate and keep track of simple invoices + * Version - 0 + * Licensed under the MIT license - https://opensource.org/licenses/MIT + * + * Copyright (c) 2021 Vidhu Kant Sharma +*/ + import React from "react"; import "./Display.css"; diff --git a/src/components/Form/AddNewItemForm.js b/src/components/Form/AddNewItemForm.js index b126022..afd5259 100644 --- a/src/components/Form/AddNewItemForm.js +++ b/src/components/Form/AddNewItemForm.js @@ -1,3 +1,11 @@ +/* + * OpenBills - Self hosted browser app to generate and keep track of simple invoices + * Version - 0 + * Licensed under the MIT license - https://opensource.org/licenses/MIT + * + * Copyright (c) 2021 Vidhu Kant Sharma +*/ + import React, { useState } from "react"; import "./Form.css"; diff --git a/src/components/Form/Form.scss b/src/components/Form/Form.scss index c9cb19c..92f227a 100644 --- a/src/components/Form/Form.scss +++ b/src/components/Form/Form.scss @@ -1,3 +1,11 @@ +/* + * OpenBills - Self hosted browser app to generate and keep track of simple invoices + * Version - 0 + * Licensed under the MIT license - https://opensource.org/licenses/MIT + * + * Copyright (c) 2021 Vidhu Kant Sharma +*/ + @import "../../styles/theme"; $inputBorders: 1px solid $altBorderColor; diff --git a/src/components/Form/MetaInfoForm.js b/src/components/Form/MetaInfoForm.js index da7f26a..96287bb 100644 --- a/src/components/Form/MetaInfoForm.js +++ b/src/components/Form/MetaInfoForm.js @@ -1,3 +1,11 @@ +/* + * OpenBills - Self hosted browser app to generate and keep track of simple invoices + * Version - 0 + * Licensed under the MIT license - https://opensource.org/licenses/MIT + * + * Copyright (c) 2021 Vidhu Kant Sharma +*/ + import React /*, { useState }*/ from "react"; import "./Form.css"; diff --git a/src/components/Header/Header.js b/src/components/Header/Header.js index d401a30..ad8d59a 100644 --- a/src/components/Header/Header.js +++ b/src/components/Header/Header.js @@ -1,3 +1,11 @@ +/* + * OpenBills - Self hosted browser app to generate and keep track of simple invoices + * Version - 0 + * Licensed under the MIT license - https://opensource.org/licenses/MIT + * + * Copyright (c) 2021 Vidhu Kant Sharma +*/ + import React from "react"; import "./Header.css"; // import React, { useState } from "react"; diff --git a/src/components/Header/Header.scss b/src/components/Header/Header.scss index cebc2cc..1d42215 100644 --- a/src/components/Header/Header.scss +++ b/src/components/Header/Header.scss @@ -1,3 +1,11 @@ +/* + * OpenBills - Self hosted browser app to generate and keep track of simple invoices + * Version - 0 + * Licensed under the MIT license - https://opensource.org/licenses/MIT + * + * Copyright (c) 2021 Vidhu Kant Sharma +*/ + @import "../../styles/_theme"; .header { diff --git a/src/index.js b/src/index.js index e63e07e..f618682 100644 --- a/src/index.js +++ b/src/index.js @@ -1,3 +1,11 @@ +/* + * OpenBills - Self hosted browser app to generate and keep track of simple invoices + * Version - 0 + * Licensed under the MIT license - https://opensource.org/licenses/MIT + * + * Copyright (c) 2021 Vidhu Kant Sharma + */ + // import React from 'react'; import ReactDOM from 'react-dom'; import "./styles/global.css" diff --git a/src/styles/global.scss b/src/styles/global.scss index df4c69a..581cb34 100644 --- a/src/styles/global.scss +++ b/src/styles/global.scss @@ -1,3 +1,11 @@ +/* + * OpenBills - Self hosted browser app to generate and keep track of simple invoices + * Version - 0 + * Licensed under the MIT license - https://opensource.org/licenses/MIT + * + * Copyright (c) 2021 Vidhu Kant Sharma +*/ + @import "theme"; * { |