Feat/readme (#136)

docs(app): add open-source related docs

CODE_OF_CONDUCT.md

@@ -0,0 +1,73 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+education, socio-economic status, nationality, personal appearance, race,
+religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at [[email protected]](mailto:[email protected]). All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org

CONTRIBUTING.md

@@ -0,0 +1,61 @@
+# Contributing to Lightence
+
+👍🎉 First off, thanks for taking the time to contribute! 🎉👍
+
+Before submitting your contribution though, please make sure to take a moment and read through the following guidelines.
+
+* [Code of Conduct](CODE_OF_CONDUCT.md)
+
+## Pull Request Guidelines
+
+* The `main` branch is just a snapshot of the latest stable release. **Do not submit PRs against the `main` branch.**
+* Atomic code contribution looks something like this:
+    * Checkout from upstream `develop`.
+    * Work on your fork in dedicated branch.
+    * When you're ready to show results - create PR against upstream `develop` and add a developer for review. You can ping said developer to speed things up ;).
+* It's OK to have multiple small commits as you work on the PR - we will let GitHub automatically squash it before merging.
+
+* Good stuff to add in your pull request:
+    * If your PR fully resolves existing issue, add `(fix #xxxx[,#xxx])` (#xxxx is the issue id) so that GitHub will close the issue once it's up on `main`. You have to add that to the body of PR, won't work in header :).
+    * Provide detailed description of the issue in the PR if it's not done in the issue.
+    * If you're working on visual changes - provide before/after screenshot. That speeds up review immensely.
+
+### Branches
+
+* Upstream branches (**altence/lightence-admin**):
+    * `main` - stable snapshot from `develop`. Releases and hotfixes only. **Do not submit PR's to `main`!**
+    * `develop` - main development branch.
+
+* Local branches
+    * For local branches naming stick to [commit message convention](https://www.conventionalcommits.org/en/v1.0.0/). So for feature branch that adds tabs name would be `feat/tabs`.
+
+### For core contributors
+
+* Keep amount of local branches minimal.
+* Always link PR to issue (via `fix #123`).
+* For small issues you may push to `develop` branch directly while adding (`fix #123`) to commit message.
+* Create single PR for one issue. If we have several PRs - move all the code into a single one and close the rest. If one PR covers several issues - either split it in several PRs or mark one of the issues as duplicate.
+* Be sure to have only one person assigned per issue.
+* We use [yarn](https://yarnpkg.com/lang/en/) for package management.
+* Be proactive. If you think something is wrong - create an issue or discuss.
+
+#### Before release workflow
+* Update package versions to the newest ones. Update lock files (for both `npm` and `yarn`)
+
+## Windows
+
+Lightence can be developed on Windows, however a few potential gotchas need to be kept in mind:
+
+1. Regular Expressions: Windows uses `\r\n` for line endings, while Unix based systems use `\n`. Therefore, when working on Regular Expressions, use `\r?\n` instead of `\n` in order to support both environments. The Node.js [`os.EOL`](https://nodejs.org/api/os.html#os_os_eol) property can be used to get an OS-specific end-of-line marker.
+2. Paths: Windows systems use `\` for the path separator, which would be returned by `path.join` and others. You could use `path.posix`, `path.posix.join`, etc... and the [slash](https://ghub.io/slash) module, if you need forward slashes - like for constructing URLs - or ensure your code works with either.
+3. Bash: Not every Windows developer has a terminal that fully supports Bash, so it's generally preferred to write scripts in JavaScript instead of Bash.
+4. Filename too long error: There are 260 characters limit for a filename when Git is compiled with `msys`. While the suggestions below are not guaranteed to work and could possibly cause other issues, a few workarounds include:
+  - Update Git configuration: `git config --system core.longpaths true`
+  - Consider using a different Git client on Windows
+
+## Getting Help
+##### You can ask any questions here
+[<img src="https://img.shields.io/badge/Gmail-D14836?style=for-the-badge&logo=gmail&logoColor=white">](mailto:[email protected])
+[<img src="https://img.shields.io/badge/Twitter-1DA1F2?style=for-the-badge&logo=twitter&logoColor=white">](https://twitter.com/altence_team)
+[<img src="https://img.shields.io/badge/Discord-7289DA?style=for-the-badge&logo=discord&logoColor=white">](https://discord.gg/YBSrDrGe)
+[<img src="https://img.shields.io/badge/Facebook-1877F2?style=for-the-badge&logo=facebook&logoColor=white">](https://www.facebook.com/groups/altence)

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Altence LLC
+
+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 FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, 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.

README.md

@@ -1,46 +1,111 @@
-# Getting Started with Create React App
-
-This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
-
-## Available Scripts
-
-In the project directory, you can run:
-
-### `yarn 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.
-
-### `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/).
+# Lightence
+
+React-powered **100% FREE** Admin Dashboard Template for building rich user interfaces significantly faster. For developers of all levels. Open-sourced and maintained by the [Altence](https://altence.com) team.
+
+## Key Features
+- 🚀 This solution allows you to reduce MVP development costs by up to 40%
+- 🐜 Lightence admin dashboard template is based on a rich library powered by [Ant Design](https://ant.design/)
+- 💰 100% Free: start using it for your projects right away. No hidden payments, no trials, nothing
+- 💊 Medical dashboard includes: customizable medical dashboard for data-driven applications
+- 🦸 Easy-to-start: check out a `starter` branch to skip demos and start building your next great project
+- 💻 Any backend supported: the dashboard supports any kind of backend by just updating an API
+- ⭐ Modern & great for projects of tomorrow: built with [React](https://reactjs.org/), [Redux](https://redux.js.org/) and [Ant Design](https://ant.design/); _Bootstrap_ and _jQuery_ free
+- 🇺🇳 Internationalized: built-in internationalization support
+- 📱 Mobile first: approach to reduce traffic on mobile devices
+- 🔥 Responsive & Adaptive: supports mobile, tablet, and desktop screens
+- ☎️ Supports PWA to get all advantages of native mobile apps
+- 🎨 Theming: use built-in light and dark themes or implement your own theme with just lines of code
+- 🏋️ Optimized bundle size: use the latest features of building tools to reduce the final bundle size
+
+## Under the Hood
+- 💯 60+ ready-to-use stunning UI components
+- 🚄 All-set business flow: login, sign up, forgot password, profile flows
+- 🐝 Custom pages: 400 error, 500 error, profile
+- 🗞️ Built-in apps: News Feed, Kanban
+- 👍 Fully typescripted
+- ✅ Clean code: enjoy the  world-recognized code style with our own enhancements
+- 🧱 Solid architecture: in compliance with the  best architectural practices
+- 📃 [MIT](LICENSE) License
+
+### Demo
+
+Check out a [live demo](https://altence.com/lightence-admin-demo).
+
+### Installation
+
+#### Requirements
+- [Node.js](https://nodejs.org/en/) version _>=16.0.0_
+- [yarn](https://yarnpkg.com/) or [npm](https://www.npmjs.com/)
+- [git](https://git-scm.com/)
+
+#### To go with the latest version please copy and past in your terminal the following steps
+
+```
+git clone https://github.com/altence/lightence-admin.git my-awesome-project && cd my-awesome-project
+```
+
+yarn, development mode
+```
+yarn install && yarn start
+```
+
+yarn, production mode
+```
+yarn install && yarn build
+```
+
+npm, development mode
+```
+npm install && npm run start
+```
+
+npm, production mode
+```
+npm install && npm run build
+```
+
+#### How to analyze the bundle size
+yarn
+```
+yarn install && yarn build --stats
+```
+
+npm
+```
+npm install && npm run build --stats
+```
+
+And then use the [webpack-bundle-analyzer](https://www.npmjs.com/package/webpack-bundle-analyzer) to open _build/bundle-stats.json_.
+
+#### How to build your project based on Lightence
+
+```
+git clone -b starter https://github.com/altence/lightence-admin.git my-awesome-project && cd my-awesome-project
+```
+And you will see a demos-free template.
+
+### Where to get help
+[<img src="https://img.shields.io/badge/Gmail-D14836?style=for-the-badge&logo=gmail&logoColor=white">](mailto:[email protected])
+[<img src="https://img.shields.io/badge/Twitter-1DA1F2?style=for-the-badge&logo=twitter&logoColor=white">](https://twitter.com/altence_team)
+[<img src="https://img.shields.io/badge/Discord-7289DA?style=for-the-badge&logo=discord&logoColor=white">](https://discord.gg/YBSrDrGe)
+[<img src="https://img.shields.io/badge/Facebook-1877F2?style=for-the-badge&logo=facebook&logoColor=white">](https://www.facebook.com/groups/altence)
+
+### Contribution
+Let’s create great products together! We encourage and welcome collaboration and any type of contribution. 👉 Learn the [contributing docs](CONTRIBUTING.md) on how to contribute the right way.
+
+### Want to get popular?
+If you use **Lightence** in your app development, please, let us know, and we’ll showcase your work to provide more awareness to your product.
+
+### Components by request
+As our admin system with a medical dashboard is fully customizable, we understand that you might need more components than it currently has. In case you didn't find a needed component inside Lightence, [contact us](mailto:[email protected]) to order it.
+
+### How you can give a shout-out to us
+
+- 🏗️ Make your disruptive products with Lightence
+- ⭐ Star our GitHub repo
+- 🐞 Create requests, submit bugs, suggest new features
+- ☄️ Spread the word and share links about **Lightence** on social media
+- 🔥 Follow us on [Twitter](https://twitter.com/altence_team) and [LinkedIn](https://linkedin.com/company/altence)
+
+### Need developers’ help?
+At [Altence](https://altence.com), we are always ready to get your feedback or give you advice if needed. We can also become your partner in development in case you need help with your projects. Drop us a line ([email](mailto:[email protected])) and we’ll get back to you shortly.

package.json

@@ -1,7 +1,15 @@
 {
-  "name": "react-antd-reactence-admin",
-  "version": "0.1.0",
-  "private": true,
+  "name": "lightence-admin",
+  "version": "1.0.0",
+  "license": "MIT",
+  "description": "Free and easy-to-use admin template based on React 17+",
+  "repository": {
+    "type": "git",
+    "url": "git+github.com:altence/lightence-admin.git"
+  },
+  "bugs": {
+    "url": "https://github.com/altence/lightence-admin/issues"
+  },
   "dependencies": {
     "@ant-design/icons": "^4.6.2",
     "@craco/craco": "^6.1.2",
@@ -73,7 +81,8 @@
   "browserslist": [
     ">0.2%",
     "not dead",
-    "not op_mini all"
+    "not op_mini all",
+    "not IE 11"
   ],
   "devDependencies": {
     "@types/country-list": "^2.1.0",
@@ -116,5 +125,6 @@
   "engines": {
     "node": ">=16.0.0"
   },
-  "packageManager": "[email protected]"
+  "packageManager": "[email protected]",
+  "keywords": ["lightence", "admin", "admin-dashboard", "ant-design", "react"]
 }