Application Boilerplate

Boilerplate to give you a headstart of developing your own desktop application.

Tech Stacks Built In

The boilerplate is developed using the following tech stacks:

    1) Electron Framework.
    2) Node Javascript.
    3) Vanilla Javascript.
    4) HTML, CSS, and Bootstrap

Database Used

Databases used in here is as follows:

1) MYSQL
2) SQLite

Choosing a database to use is upon your preference. Both works fine. SQLite can be used on both local machine memory or be created on the root folder of the project.

More Databases to be Implemented here sooner or later.

Get Started

To get started is simply understanding how to contribute and run the application on a local machine.

Installations

The following is needed before running the application. You just need to install the following on your machine:

1. Node, to download use link, https://nodejs.org/en/download/
2. Git, to download use link, https://git-scm.com/downloads

After installations are complete, do some setups of git setups. Use the below link to get your setups done:

https://git-scm.com/book/en/v2/Getting-Started-First-Time-Git-Setup

Prerequisites (Download and Run):

The following are the prerequisites to use:

1. git clone -b main https://github.com/Gicehajunior/app-boilerplate-electron.git or Download a zip file using, https://github.com/Gicehajunior/app-boilerplate-electron/archive/refs/heads/main.zip
2. Move your project to the directory of your preference.
3. Open the project in your IDE of preference. Recommended one is; Visual Studio Code (VsCode).
4. Create .env file on the root folder.
5. Open .env-example and copy the it's contents to created .env file
6. Set the Required environment variables correctly.

Database

The database is upon on your preference.
7) Do the following:
For:
> SQLite:
To use SQLite database, On .env file, set DB_CONNECTION as "sqlite" and DB_NAME your name of preference.
> MYSQL:
To use MYSQL database, On .env file, set DB_CONNECTION as "mysql" and DB_NAME your name of preference

Run Application Now

To run your application after doing the above, Is simple as:

Open the powershell and do the following respectively:

:\>cd project_directory
:\>npm install
:\>npm start

Understand Application Archtecture

This simply entails how the application is made and the MVC archtechture to be precise.

--------------------VISIT THIS REPOSITORY REGULARY TO KNOW MORE ABOUT THIS--------------------

CONTRIBUTION

Feel free to push pull requests and They will be merged if acceptable.

ISSUES

Ready to file an issue? Well, Get it posted and it will be curated and get sorted. Critics are also accepted.

NOTE:
Excoriations needs to be in the code context. More than that, will be rejected.

Thank you.

LICENSE

MIT LICENSE