/learning-platform

A SPA platform for managing training and courses made with Svelte.

Primary LanguageSvelteMIT LicenseMIT


Learning Platform

A SPA platform for managing training and courses made with Svelte.

Explore the docs »
Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Acknowledgements
  6. Contributing
  7. License
  8. Contact

About The Project

Um GIF navegando entre as páginas do learning platform Um mockup mostrando todas as páginas do learning platform

Figma Mockup: learning-platform

Features

  • Create/Edit/Delete courses
  • Create/Edit/Delete modules
  • Create/Edit/Delete lessons
  • Update user profile

Built With

  • Svelte - A lightweight framework for building interactive UIs
  • Vite - A static compiler for Svelte
  • Svelte Navigator - A Svelte SPA router plugin
  • TypeScript - A typed superset of JavaScript
  • uuid - A library for generating UUIDs

Getting Started

To get a local copy up and running follow these simple steps.

Installation

  1. Clone the repo 
    git clone https://github.com/xandao-dev/learning-platform.git
  2. Install dependencies 
     cd learning-platform
 npm install # or yarn install

Usage

  • Starts the development server 
    npm run dev # or yarn dev
  • Launch production server 
    npm run build # or yarn build
npm run preview # or yarn preview

Roadmap

See the open issues for a list of proposed features (and known issues).

Acknowledgements

  • Docker images are stored in the Docker Hub
  • Configs and logs are addressed to docker volumes specified in the docker-compose.yml file at production folder

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Free software =)

Contact

Alexandre Calil - Linkedin - alexandre@xandao.dev

Project Link: https://github.com/xandao-dev/learning-platform