Skip to content

Commit

Permalink
Review README
Browse files Browse the repository at this point in the history
  • Loading branch information
DercilioFontes committed Dec 29, 2022
1 parent afc950e commit 0751c84
Show file tree
Hide file tree
Showing 4 changed files with 21 additions and 19 deletions.
21 changes: 7 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,34 +1,27 @@
# Admin Dashboard Template
# Stats Calculator

Ease developers’ life with the React Suite 5. TypeScript will help with optimizing. Quick start & easily extensible code.
Studying stats and building a web tool to calculate stats, charts and tables.

![preview](./preview-1.png)

![preview](./preview-2.png)
![preview](./preview.png)

## Development

Fork this repo to your namespace and clone to your local machine.

```
git clone [email protected]:<YOUR NAME>/rsuite-admin-template.git
$ cd rsuite-admin-template
```
Forked from rsuite/rsuite-admin-template

Install dependencies
Clone repo and install dependencies

```
npm install
```

Now you can start the development server by running npm run dev

It's serving at http://127.0.0.1:3100/ by default.
It's serving at http://localhost:3100/ by default.

```
npm run dev
```

## License

MIT © [simonguo](https://github.com/simonguo)
MIT
9 changes: 4 additions & 5 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "rsuite-admin-template",
"name": "stats-calculator",
"version": "1.0.0",
"description": "RSUITE Management System",
"description": "Stats calculator website",
"main": "lib/index.js",
"directories": {
"lib": "lib/"
Expand All @@ -21,15 +21,14 @@
"chart"
],
"files": [
"CHANGELOG.md",
"lib",
"src"
],
"author": "HYPERS Team",
"author": "Dercilio Fontes",
"license": "MIT",
"repository": {
"type": "git",
"url": "[email protected]:rsuite/rsuite-admin-template.git"
"url": "[email protected]:DercilioFontes/stats.git"
},
"dependencies": {
"@babel/runtime": "^7.20.7",
Expand Down
Binary file added preview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
10 changes: 10 additions & 0 deletions src/pages/info/Info.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,16 @@ const Info = () => {
</li>
</ol>
</section>
<section>
<h6>Issues</h6>
<p>
If you find any issues or want to give any suggestion, you can add it{' '}
<a href="https://github.com/DercilioFontes/stats/issues" target="_blank" rel="noreferrer">
here
</a>
.
</p>
</section>
</>
);
};
Expand Down

0 comments on commit 0751c84

Please sign in to comment.