0.3.0 • Published 2 years ago

fuckhomework v0.3.0

Weekly downloads
-
License
MIT
Repository
-
Last release
2 years ago

FuckHomework

GitHub GitHub package.json version GitHub commit activity (branch)

Introduction

This is a SvelteKit web application to blame and manage received homework of yours.

Features

  • Succinct Web UI
  • Custom validation rules
  • Internationalization

Getting started

First make sure your machine has git, node, npm and yarn installed. Then clone the repository:

git clone https://github.com/LittleYe233/FuckHomework.git
cd FuckHomework

Then install the dependencies:

yarn

Now you can configure the application (via Configuration) and launch it:

# development server
npm run dev

Configuration

All configurations are stored in config.js, which is ignored by Git. So after cloning the repository, make sure to create it in the root folder. The only required field is version which should be 1 now:

export default {
    version: 1
};

Also you can copy or rename config.example.js to config.js which includes most of the supported fields and most of their values are default ones.

To-do list

  • User management and permission
  • Validation rules on back-end
  • More optional visualization
  • Due time restriction
  • Classification for ongoing and finished homework

Technology stack

  • TypeScript
  • Vite
  • Svelte & SvelteKit
  • Tailwind CSS

Donate

Planned.

License

MIT license