README.md

Version Management System

This web app allows DhiWise to manage their internal versions for both technologies, ReactJS and Flutter.

The source code of this repository is generated by DhiWise, a ProCode programming platform where developers can convert their designs into developer-friendly code for mobile and web apps with dynamic data and much more.

DhiWise automates the application development lifecycle and instantly generates readable, modular and reusable code.

Table of Contents

• Features
• Screenshots
• Setup
• Xata DB Schema
• Version of Technologies
• Folder Structure
• Libraries used
• License
• Community

Features

1. Add the name of the software and version number.
2. Edit them in real-time with Xatabase.
3. Delete or list all the versions' names.

Screenshots

Setup

1. Get a Xata account from here
2. Create an application and put the token inside the src/constants/creds.js as a XATA_TOKEN constant.
3. The COMMON_URL might differ from the existing one when you create your DB in XATA. Replace it with yours inside src/service file.

Clone the repo

$ git clone https://github.com/DhiWise/XataVersionManager
$ cd XataVersionManager/
$ npm i
$ npm start --reset-cache

Running the storybook

We have detected common components and have generated possible variants of it. To check the documentation of generated common components by integrating storybook, Please follow below steps.

Install and Initializes

 npx storybook init

Run the Storybook

  npm run storybook

The .env file

This file contains various environment variables that you can configure.

PORT - Port to run your frontend on
REACT_APP_GOOGLE_CLIENT_ID - (Optional) Your Google Client ID. Get it from here

Xata DB Schema

• To test this, you must create a DB schema as below:
  1. Create a workspace named "Versions"
  2. Create a Xatabase (database) named as "live"
  3. Into the main branch, create 2 tables. one as "react" and another as "flutter"
  4. Both tables will have following schema:
     • id
     • generator_name [string]
     • version [string]

Version of Technologies

• git - v2.13 or greater
• NodeJS - 12 || 14
• npm - v6 or greater

Folder Structure

After creation, your project should look like this:

.
├── package.json
├── package-lock.json
├── postcss.config.js
├── public
│   ├── favicon.ico
│   ├── index.html
│   ├── logo192.png
│   ├── logo512.png
│   ├── manifest.json
│   └── robots.txt
├── README.md
├── src
│   ├── App.js
│   ├── assets
│   │   ├── fonts ---------- Project fonts
│   │   └── images --------- All Project Images
│   ├── components --------- UI and Detected Common Components
│   ├── constants ---------- Project constants, eg: string consts
│   ├── hooks -------------- Helpful Hooks
│   ├── index.js
│   ├── pages -------------- All route pages
│   ├── Routes.js ---------- Routing
│   ├── styles
│   │   ├── index.css ------ Other Global Styles
│   │   └── tailwind.css --- Default Tailwind modules
│   └── util
│       └── index.js ------- Helpful utils
└── tailwind.config.js ----- Entire theme config, colors, fonts etc.

Libraries used in this repository

1. @tailwindcss/forms: 0.4.0
2. react: 17.0.2
3. react-datepicker: ^4.5.0
4. react-dom: 17.0.2
5. react-router-dom: 6.0.2
6. react-router-hash-link: ^2.4.3
7. react-scripts: 5.0.0
8. web-vitals: ^2.1.0
9. axios: ^0.27.2
10. lodash: ^4.17.21
11. yup: ^0.32.11
12. react-toastify: ^9.0.1
13. prop-types: ^15.8.1
14. react-modal: ^3.14.4
15. autoprefixer - 10.4.2
16. postcss - 8.4.6
17. tailwindcss - 3.0.18

License

MIT License

Copyright (c) 2022 DhiWise

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 NON-INFRINGEMENT. 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.

Community