Skip to content

Latest commit

 

History

History
71 lines (53 loc) · 2.85 KB

README.md

File metadata and controls

71 lines (53 loc) · 2.85 KB
Raw

ACES Software Aids

This is a repository for the front end of the Software Aids project. 👋 The Aim of this project is to make it extremely easy for people around the world to create and build web pages/content.

Setup 🎯

To avoid the stress, If you know; That your intentions are purely to use this software and not necessarily to contribute, Visit http://kwickerhub.com and begin using the software. It is safe, simple, and less stressful.

But if you want to contribute, please follow the steps below.

Firstly, clone this repo using:

git clone *repo URL here (without asterisks)*

To have a better experience, you can also clone our backend project, as the frontend project feeds directly from that API. clone both the backend and frontend in one folder. Enjoy the power of KwickerHub.

git clone *repo URL here of backend (without asterisks)*

read the set-up file in the backend and install the backend structures and Database. import the SQL file into your SQL manager(or PHPmyAdmin) open the frontend section in your localhost.

Contributions

Version Control Conventions

‼️IMPORTANT! Make sure you read this before you contribute! ‼️

  • Create a new branch for every feature you add.
  • Push and create a pull request to the dev branch.
  • Do not push directly to main, dev or deploy branches!
  • Use snake_case for branch names.
  • Write descriptive commit messages.
  • Explain what you did in a few words in your pull request comment.
  • Never merge or close a PR yourself - one person is solely responsible for handling this to avoid confusion!

Style Conventions ✍️

You'll see the folder structure and file naming standards, please abide by them.

  • Create a folder for the page you're working on in the pages folder.
  • Create css, images, js files within the appropriate folders.

Below is a sample of the folder structure: 

 |-- assets
    |-- icons
    |-- img
    |-- css
    |-- vendor

 |-- pages
     -signup.html

  • Create all JS files in the js folder

  • Images & icons go in the images & icons folders respectively.

  • Use lowercase letters for file names.

  • Use hyphens for naming CSS classes and IDs, e.g. header-section. Use readable names.

  • For Javascript functions/variables, use the snake_case naming convention.

  • Please remember to write comments so that others can follow.

Style Guide Examples 📖

Thank you and well done for contributing! 👏

Typing Gif