Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
3kh0 authored Sep 30, 2023
1 parent 79e40cd commit 0129bd9
Showing 1 changed file with 12 additions and 8 deletions.
20 changes: 12 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,35 +1,39 @@
# 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.
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 intensions are purely to use this software and not neccessarily to contribute, Visit http://kwickerhub.com and begin using the software. It is safe, simple and less stressful.
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.

But if you intend to contribute, you have to follow the steps below.
Firstly, clone this repo using:

```bash
git clone *repo URL here (without asterisks)*
```
To have a better experience, you may also want to 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.
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.
```bash
git clone *repo URL here of backend (without asterisks)*
```

read the set-up file in the backend and get the backend strucutures and Database installed.
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!) ‼️
### 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 by yourself - one person is solely responsible for handling this to avoid confusion!
* 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.
Expand All @@ -52,7 +56,7 @@ You'll see the folder structure and file naming standards, please abide by them.

* Images & icons go in the ```images``` & ```icons``` folders respectively.
* Use lowercase letters for file names.
* Use hyphens for naming CSS-classes and IDs, eg ```header-section```. Use readable 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.

Expand Down

0 comments on commit 0129bd9

Please sign in to comment.