Skip to content

Commit bac7c7d

Browse files
Merge pull request #38 from Chia-Network/develop
Release 0.0.14
2 parents 1dc68a6 + 9c0abe3 commit bac7c7d

File tree

3 files changed

+29
-74
lines changed

3 files changed

+29
-74
lines changed

README.md

+27-72
Original file line numberDiff line numberDiff line change
@@ -1,93 +1,48 @@
1-
<h1 align="center">
2-
Vite Template React
3-
</h1>
1+
# Core Registry UI
42

5-
<p align="center">
6-
<a href="https://github.com/SafdarJamal/vite-template-react/releases">
7-
<img src="https://img.shields.io/github/v/release/SafdarJamal/vite-template-react" alt="GitHub Release (latest by date)" />
8-
</a>
9-
<a href="https://github.com/SafdarJamal/vite-template-react/blob/main/LICENSE">
10-
<img src="https://img.shields.io/github/license/SafdarJamal/vite-template-react" alt="License" />
11-
</a>
12-
</p>
3+
User interface for the [Core Registry API](https://github.com/Chia-Network/core-registry-api). Combines [Core Registry CADT UI](https://github.com/Chia-Network/core-registry-cadt-ui/), [Climate Tokenization Engine UI](https://github.com/Chia-Network/Climate-Tokenization-Engine-UI), and [Climate Explorer UI](https://github.com/Chia-Network/climate-explorer-ui) into a single interface.
134

14-
<p align="center">
15-
A <a href="https://vitejs.dev">Vite</a> + <a href="https://react.dev">React</a> starter template.
16-
</p>
5+
## Installation
176

18-
![Vite Template React](https://github.com/SafdarJamal/vite-template-react/assets/48409548/4b1eb99e-01b8-4752-91c0-76930e7948c1)
7+
The UI application can be hosted as a web application and accessed via the browser, or as a desktop application packaged with Electron. Currently the application is only packaged for x86 platforms, though building from source is expected to work on ARM.
198

20-
## Folder Structure
9+
### Desktop Applications
2110

22-
No configuration or complicated folder structures, just the files you need to build your app:
11+
The [releases](https://github.com/Chia-Network/core-registry-ui/releases) page provides desktop applications packaged for Windows, Mac, and Debian-based Linux distributions.
2312

24-
```
25-
vite-template-react
26-
├── node_modules
27-
├── public
28-
│ ├── favicon.svg
29-
│ └── robots.txt
30-
└── src
31-
├── App.css
32-
├── App.jsx
33-
├── App.test.jsx
34-
├── index.css
35-
├── index.jsx
36-
└── logo.svg
37-
└── setupTests.js
38-
├── .gitignore
39-
├── index.html
40-
├── package.json
41-
├── README.md
42-
├── vite.config.js
43-
```
44-
45-
## Development
13+
### Web Application
4614

47-
To get a local copy of the code, clone it using git:
48-
49-
```
50-
git clone https://github.com/SafdarJamal/vite-template-react.git
51-
cd vite-template-react
52-
```
15+
The Core Registry UI can be hosted as a web application, either for internal use, or made available to the public. When operating as a web application, the user's browser must be able to connect to the [Core Registry API](https://github.com/Chia-Network/core-registry-api). This means the API must be available on the public internet if the UI is public. Always set an API key to prevent unauthorized access.
5316

54-
Make it your own:
17+
To host the UI on the web, use the [web-build.tar.gz file from the releases page](https://github.com/Chia-Network/core-registry-ui/releases). One of the simplest solutions is to uncompress these files into a [public S3 bucket](https://docs.aws.amazon.com/AmazonS3/latest/userguide/WebsiteAccessPermissionsReqd.html). These files could also be served by any webserver, such as Nginx or Apache.
5518

56-
```
57-
rm -rf .git && git init && npm init
58-
git add .
59-
git commit -m "Initial commit"
60-
```
19+
## Contributing
6120

62-
Install dependencies:
21+
Upon your first commit, you will automatically be added to the package.json file as a contributor.
6322

64-
```
65-
npm i
66-
```
23+
## Commiting
6724

68-
Now, you can start a local web server by running:
25+
This repo uses a commit convention. A typical commit message might read:
6926

7027
```
71-
npm start
28+
fix: correct home screen layout
7229
```
7330

74-
And then open http://localhost:3000 to view it in the browser.
75-
76-
#### Available Scripts
77-
78-
In this project, you can run the following scripts:
31+
The first part of this is the commit "type". The most common types are "feat" for new features, and "fix" for bugfixes. Using these commit types helps us correctly manage our version numbers and changelogs. Since our release process calculates new version numbers from our commits it is very important to get this right.
7932

80-
| Script | Description |
81-
| ------------- | ------------------------------------------------------- |
82-
| npm start | Runs the app in the development mode. |
83-
| npm test | Launches the test runner in the interactive watch mode. |
84-
| npm run build | Builds the app for production to the `dist` folder. |
85-
| npm run serve | Serves the production build from the `dist` folder. |
33+
- `feat` is for introducing a new feature
34+
- `fix` is for bug fixes
35+
- `docs` for documentation only changes
36+
- `style` is for code formatting only
37+
- `refactor` is for changes to code which should not be detectable by users or testers
38+
- `test` is for changes which only touch test files or related tooling
39+
- `build` is for changes which only touch our develop/release tools
40+
- `chore` is for housekeeping tasks such as hydrating from another branch
8641

87-
## Credits
42+
After the type and scope there should be a colon.
8843

89-
Vite Template React is built and maintained by [Safdar Jamal](https://safdarjamal.github.io).
44+
The "subject" of the commit follows. It should be a short indication of the change. The commit convention prefers that this is written in the present-imperative tense.
9045

91-
## License
46+
### Commit linting
9247

93-
This project is licensed under the terms of the [MIT license](https://github.com/SafdarJamal/vite-template-react/blob/main/LICENSE).
48+
Each time you commit the message will be checked against these standards in a pre-commit hook. Additionally all the commits in a PR branch will be linted before it can be merged to main.

app-builds.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
module.exports = {
22
cadt: {
3-
tag: "1.3.6",
3+
tag: "1.3.7",
44
url: "https://github.com/Chia-Network/core-registry-cadt-ui/releases/download/{{tag}}/core-registry-cadt-ui-web-build.tar.gz",
55
},
66
climate_explorer: {

package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "core-registry-ui",
3-
"version": "0.0.13",
3+
"version": "0.0.14",
44
"scripts": {
55
"start": "nf start -p 3001",
66
"electron": "electron .",

0 commit comments

Comments
 (0)