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

A SPA platform for managing training and courses made with Svelte.
https://github.com/xandao-dev/learning-platform

aws course-platform docker spa svelte training-platform typescript vite

Last synced: 11 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/xandao-dev/learning-platform
• Owner: xandao-dev
• License: mit
• Created: 2022-03-14T22:06:11.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-11-07T15:13:03.000Z (about 2 years ago)
• Last Synced: 2024-10-10T12:50:43.214Z (29 days ago)
• Topics: aws, course-platform, docker, spa, svelte, training-platform, typescript, vite
• Language: Svelte
• Homepage: https://ead.xandao.dev
• Size: 1.91 MB
• Stars: 4
• Watchers: 2
• Forks: 1
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        





  
Learning Platform


  


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

    


    


    Explore the docs »

    


    Report Bug

    ·

    Request Feature

  


  Table of Contents

  


    


      About The Project

      


        
Features

        
Built With

      

    

	


      Getting Started

      


        
Installation

      

    

    
Usage

    
Roadmap

	
Acknowledgements

    
Contributing

    
License

    
Contact

  


## About The Project



  

    

    

  



Figma Mockup: [learning-platform](https://www.figma.com/file/YDOwfyVz4tPOQ041BS4mh0/Learning-Platform)

### Features

* Create/Edit/Delete courses

* Create/Edit/Delete modules

* Create/Edit/Delete lessons

* Update user profile

### Built With

* [Svelte](https://svelte.dev/) - A lightweight framework for building interactive UIs

* [Vite](https://vite.dev/) - A static compiler for Svelte

* [Svelte Navigator](https://github.com/mefechoel/svelte-navigator) - A Svelte SPA router plugin

* [TypeScript](https://www.typescriptlang.org/) - A typed superset of JavaScript

* [uuid](https://github.com/uuidjs/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

   ```sh

   git clone https://github.com/xandao-dev/learning-platform.git

   ```

2. Install dependencies

   ```sh

	cd learning-platform

	npm install # or yarn install

	```

## Usage

* Starts the development server

	```sh

  npm run dev # or yarn dev

  ```

* Launch production server

  ```sh

  npm run build # or yarn build

  npm run preview # or yarn preview

  ```

## Roadmap

See the [open issues](https://github.com/xandao-dev/learning-platform/issues) for a list of proposed features (and known issues).

## Acknowledgements

* Docker images are stored in the [Docker Hub](https://hub.docker.com/r/xandao6/learning-platform)

* 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](./LICENSE.md) for more information.

Free software =)

## Contact

Alexandre Calil - [Linkedin](https://www.linkedin.com/in/xandao-dev/) - [[email protected]](mailto:[email protected])

Project Link: [https://github.com/xandao-dev/learning-platform](https://github.com/xandao-dev/learning-platform)