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.
To avoid the stress, If you know; That your intentions are purely to use this software and not necessarily to contribute, Visit https://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.
- 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
ordeploy
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!
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.
|-- 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.
- If you're unsure about code style, follow the
style guides
. - Link to a JavaScript style guide (AirBnB).
- Link to an HTML/CSS style guide (Google).
- Please go through the style guides at least once!
Thank you and well done for contributing! 👏