chore(README): Updated README.md
This commit is contained in:
84
.github/README.md
vendored
84
.github/README.md
vendored
@@ -1,23 +1,91 @@
|
||||
<div align='center'>
|
||||
<h1>Lored / ToToday.app</h1>
|
||||
<p>A single page web app to help yours day-to-day tasks</p>
|
||||
<p><i>Built with <a href="https://nuxtjs.org" target="_blank">Nuxt.js</a></i></p>
|
||||
<a href="http://totoday.vercel.app">
|
||||
<img src="./assets/banner.png" width="800" style="border-radius: 50px;"/>
|
||||
<p>ToToday.vercel.app</p>
|
||||
</a>
|
||||
|
||||
![Lored][loredbadge]
|
||||
![Version][versionbadge]
|
||||
![Theme][themebadge]
|
||||
![License][licensebadge]
|
||||
|
||||
[![Issues][issuesbadge]][issues]
|
||||
[![PullRequests][pullrequestsbadge]][pullrequests]
|
||||
|
||||
</div>
|
||||
|
||||
<div align='center'>
|
||||
|
||||
## About
|
||||
|
||||
</div>
|
||||
|
||||
ToToday is a single-page app created to help you with your daily tasks in a more simple but organized way,
|
||||
so you don't get lost or forget what to do in the day and can focus on the tasks themselves.
|
||||
|
||||
##### Development:
|
||||
|
||||
The app is created with [Vue][vue] and the [Nuxt.js][nuxtjs] framework, being a PWA,
|
||||
it works mostly on the frontend side, using the browser's local storage to keep the task list storage.
|
||||
The color palette used is the [CuppCat][cuppcat] theme, based on the [Catppuccin][catppuccin] theme,
|
||||
icons provided by [Iconoir][iconoir].
|
||||
|
||||
> Even already being published and on the 1.0.0, it's still in
|
||||
> development and will be more polished and have more features and
|
||||
> functionalities. You can see all the planned things for future
|
||||
> updates on the [projects tab][projects].
|
||||
|
||||
<div align='center'>
|
||||
|
||||
## Build Setup
|
||||
|
||||
</div>
|
||||
|
||||
```bash
|
||||
# install dependencies
|
||||
$ npm install
|
||||
|
||||
# serve with hot reload at localhost:3000
|
||||
# server with hot reload at localhost:3000
|
||||
$ npm run dev
|
||||
|
||||
# build for production and launch server
|
||||
$ npm run build:start
|
||||
|
||||
# generate static project
|
||||
$ npm run generate
|
||||
```
|
||||
|
||||
For a detailed explanation of Nuxt.js, check the [documentation](https://nuxtjs.org).
|
||||
For a detailed explanation of Nuxt.js, check the [documentation][nuxtdocs].
|
||||
|
||||
<div align='center'>
|
||||
|
||||
[][verceldeploy]
|
||||
|
||||
</div>
|
||||
|
||||
---
|
||||
|
||||
<div align='center'>
|
||||
<img src="./assets/lored-logo.png" width="200"/>
|
||||
<br />
|
||||
<p>ToToday is a open source project created by Lored and it's licensed under the <a href="../LICENSE">MIT license</a>.</p>
|
||||
|
||||
[![Support][supportbadge]][support]
|
||||
|
||||
</div>
|
||||
|
||||
[loredbadge]: https://img.shields.io/badge/By-Lored-white?style=flat-square&labelColor=161032&color=b3f5bc
|
||||
[versionbadge]: https://img.shields.io/github/package-json/v/LoredDev/ToToday.app?style=flat-square&label=Version&logo=github&logoColor=96cdfb&labelColor=161032&color=96cdfb
|
||||
[themebadge]: https://img.shields.io/badge/Theme-CuppCat-white?style=flat-square&labelColor=161032&color=b3f5bc&logo=coffeescript&logoColor=b3f5bc
|
||||
[licensebadge]: https://img.shields.io/badge/License-MIT-white?style=flat-square&logo=Open%20Source%20Initiative&logoColor=96cdfb&labelColor=161032&color=96cdfb
|
||||
[issuesbadge]: https://img.shields.io/github/issues-raw/LoredDev/ToToday.app?style=flat-square&label=Issues&logoColor=fc6d6d&labelColor=161032&color=fc6d6d
|
||||
[pullrequestsbadge]: https://img.shields.io/github/issues-pr-raw/LoredDev/ToToday.app?style=flat-square&label=Pull%20Requests&logoColor=c78dff&labelColor=161032&color=c78dff
|
||||
[supportbadge]: https://img.shields.io/badge/Support-white?style=flat-square&labelColor=d9e0ee&color=d9e0ee&logoColor=161320&logo=Buy%20Me%20A%20Coffee
|
||||
[issues]: https://github.com/LoredDev/ToToday.app/issues
|
||||
[pullrequests]: https://github.com/LoredDev/ToToday.app/pulls
|
||||
[support]: https://www.buymeacoffee.com/guz013
|
||||
[vue]: vuejs.org
|
||||
[nuxtjs]: https://nuxtjs.org
|
||||
[iconoir]: https://iconoir.com/
|
||||
[cuppcat]: https://github.com/LoredDev/CatCupp.theme
|
||||
[catppuccin]: https://github.com/catppuccin/catppuccin
|
||||
[projects]: https://github.com/LoredDev/ToToday.app/projects
|
||||
[verceldeploy]: https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2FLoredDev%2FToToday.app%2F&project-name=lored-totoday-app&repo-name=Lored-ToToday.app
|
||||
[nuxtdocs]: https://nuxtjs.org/docs
|
||||
|
||||
BIN
.github/assets/banner.png
vendored
Normal file
BIN
.github/assets/banner.png
vendored
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 26 KiB |
BIN
.github/assets/coffee.png
vendored
Normal file
BIN
.github/assets/coffee.png
vendored
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 21 KiB |
BIN
.github/assets/lored-logo.png
vendored
Normal file
BIN
.github/assets/lored-logo.png
vendored
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 4.9 KiB |
Reference in New Issue
Block a user