From 8bf44877c41e27720cee7a8a4badb48cfd66f992 Mon Sep 17 00:00:00 2001 From: George Khoury Date: Tue, 15 Nov 2022 18:21:44 +0300 Subject: [PATCH 1/4] Update .drone.yml --- .drone.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.drone.yml b/.drone.yml index 2548fa2..0b5c4ab 100644 --- a/.drone.yml +++ b/.drone.yml @@ -17,6 +17,8 @@ steps: repo: josaorg/community-web build_args_from_env: [ + COMMUNITY_API_URL=https://community.api.prod.josa.ngo/v2, + TARGET_ENV=production, DRONE_BUILD_NUMBER, DRONE_BUILD_LINK, DRONE_COMMIT_SHA, From 686d17da8295b4a8d4b248a29421dd0abf139b1a Mon Sep 17 00:00:00 2001 From: George Khoury Date: Tue, 15 Nov 2022 18:33:20 +0300 Subject: [PATCH 2/4] Update .drone.yml --- .drone.yml | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/.drone.yml b/.drone.yml index 0b5c4ab..a5604fd 100644 --- a/.drone.yml +++ b/.drone.yml @@ -15,10 +15,13 @@ steps: image: plugins/docker settings: repo: josaorg/community-web - build_args_from_env: + build_args: [ COMMUNITY_API_URL=https://community.api.prod.josa.ngo/v2, TARGET_ENV=production, + ] + build_args_from_env: + [ DRONE_BUILD_NUMBER, DRONE_BUILD_LINK, DRONE_COMMIT_SHA, From 3fadcef519e0a8ac508e6b1b537d4719c146f7ca Mon Sep 17 00:00:00 2001 From: George Khoury Date: Tue, 15 Nov 2022 18:34:02 +0300 Subject: [PATCH 3/4] Update .drone.yml --- .drone.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.drone.yml b/.drone.yml index a5604fd..4be6fea 100644 --- a/.drone.yml +++ b/.drone.yml @@ -15,7 +15,7 @@ steps: image: plugins/docker settings: repo: josaorg/community-web - build_args: + build_args: [ COMMUNITY_API_URL=https://community.api.prod.josa.ngo/v2, TARGET_ENV=production, From 44f2b2eb25375a3582099b0e22f0c62b0df101e0 Mon Sep 17 00:00:00 2001 From: Mo Mansour Date: Sat, 14 Oct 2023 14:25:31 +0300 Subject: [PATCH 4/4] Create CONTRIBUTING.md Add it to main --- CONTRIBUTING.md | 62 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 62 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..5699059 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,62 @@ +## Contributing to JOSA.community + +Thank you for your interest in contributing to our project! We welcome your help and appreciate your support. +To ensure a smooth and collaborative process, please take a moment to review this contributing guide. + +## Code or Documentation Contributions + +1. [Fork this repository](https://github.com/jordanopensource/community-web/fork). +2. Clone the forked repository to your local machine with this command: +`git clone https://github.com//community-web.git` +3. Switch to `development` branch with this command: `git checkout development`. +**If your contribution is a documentation, jump to step 7 below**. +4. (**_You can ignore this step if you're using docker compose_**) Create a `.env` file and copy the content of [`.env.sample`](https://github.com/jordanopensource/community-web/blob/development/.env.sample) file into it, +then add the value(s) of environment variable(s). +You can use the current running API URL as the value to `NUXT_PUBLIC_COMMUNITY_API_URL` variable as the following: +`NUXT_PUBLIC_COMMUNITY_API_URL=https://community.api.prod.josa.ngo/v2`. +(_other environment variables are optional_). + +5. [Run the project locally](https://github.com/jordanopensource/community-web/blob/main/CONTRIBUTING.md#running-the-project-locally). +6. Check current [issues](https://github.com/jordanopensource/community-web/issues), +and if you're a beginner, you can [filter issues with `good first issues` label](https://github.com/jordanopensource/contributions-web/issues?q=is%3Aopen+is%3Aissue+label%3Ahacktoberfest+label%3A%22good+first+issue%22). +If you decide to work on one of the issues, write a comment on the issue asking to be assigned to it. +_Do not work on issues that you're not assigned to in order to avoid duplicate work_. +7. Create a new branch from `development` branch for the task that you want to work on: + `git checkout -b /branch-title` + - ``: The prefix should be one of the following: + - `feat` for new features + - `fix` for bug fixes + - `task` for other general tasks + - `docs` for documentation + - `branch-title` should be short and concise and written in kebab-case (separate each word with '-') +**Example**: + ```sh + git checkout development && git pull # pull the latest changes from development branch + + git checkout -b fix/type # create new branch + ``` + +8. Write descriptive and concise commit messages. + Follow these guidelines when writing commit messages: + - Limit the first line of the commit message to 72 characters or less. + - Use the imperative mood and present tense in the subject line, e.g. "Fix typo in the homepage" instead of "Fixed typo...". + - Use the body of the commit message to provide additional context or details, _if necessary_. + - Use bullet points in the body of the commit message to break down changes, _if necessary_. + +9. Push to your branch and then make a pull request from your branch to the base `development`. + +### Running the Project Locally + +#### Using Docker +Make sure that [docker](https://docs.docker.com/engine/install/) is installed on your system +and then run the project locally using [docker compose](https://github.com/jordanopensource/community-web/blob/development/docker-compose.yaml) with this command: +`docker compose up`. + +#### Using Node: +1. Make sure [Node](https://nodejs.org/en) v18 is installed. Alternatively, you can use [NVM](https://github.com/nvm-sh/nvm#installing-and-updating) to install any node version. +2. Navigate to the project directory and run `npm i` to install the dependancies. +3. Run the project in development mode by running `npm run dev`. You can now preview the project on port `3000` by visiting `http://localhost:3000/` in your browser. + +## Issues and Features Requests + +If you want to report a bug or submit a feature request, please use one of the [templates here](https://github.com/jordanopensource/community-web/issues/new/choose).