Svelte PBBG Template

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

This project creates a standard svelte template for creating applications.

Concepts: Built in docker - Install and bring up in minutes. REST to login SocketIO is used for all inside communication.

Authentication Methods:

• Discord
• Local Login
• Guest Login

Here's why:

• Your time should be focused on creating content. Use this as an accelerator to build your project.
• This template will contain the lessons I've learned and over the various projects/examples I've built upon.
• You should implement DRY principles to the rest of your life 😄

(back to top)

Built With

This section should list any major frameworks/libraries used to bootstrap your project. Leave any add-ons/plugins for the acknowledgements section. Here are a few examples.

• Docker
• NodeJS
• Redis
• MongoDB
• 
• 

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• npm

  npm install npm@latest -g

Installation

Below is an example of how you can instruct your audience on installing and setting up your app. This template doesn't rely on any external dependencies or services.

1. Install Docker
2. Clone the repo

   git clone https://github.com/pirion/svelte-pbbg-template.git

3. Create your application at discord: https://discord.com/developers/applications
4. Update docker-compose.yml with the DISCORD_CALLBACK_URL, DISCORD_CLIENT_ID, DISCORD_CLIENT_SECRET
5. Run the docker compose

docker compose up

6. Navigate to pbbg.localtest.com to view your app.

(back to top)

Usage

Create a pull request to add your site here.

(back to top)

Roadmap

• Upgrade to Svelte 1.0

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

(back to top)

Contributing

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

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

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

(back to top)

License

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

(back to top)

Contact

Kaine Adams - pirionxii@gmail.com

Project Link: https://github.com/pirion/svelte-pbbg-template

(back to top)

Acknowledgments

Use this space to list resources you find helpful and would like to give credit to. I've included a few of my favorites to kick things off!

• Best README Template

(back to top)