From f11ef73cdd3b1ab8e1ff03e6801f2310d78cb554 Mon Sep 17 00:00:00 2001 From: Ali Hassan Date: Mon, 3 Feb 2020 18:26:26 +0200 Subject: [PATCH 1/3] chore: added a contribution.md file --- CONTRIBUTION.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 CONTRIBUTION.md diff --git a/CONTRIBUTION.md b/CONTRIBUTION.md new file mode 100644 index 0000000..16efcad --- /dev/null +++ b/CONTRIBUTION.md @@ -0,0 +1,18 @@ +# Contributing +When contributing to this repository , first make sure to discuss the change you wish to make via an [issue](https://github.com/ahmadalfy/gitlab-explorer/issues) + +## Installation: +### Note: make sure to use the latest version of Chrome and enable the experamintal javascript flag from `chrome://flags`, this is important since some of the javascript used here are still not official yet. + +1. Fork this repo and clone that fork from your account to your local machine. +2. Install the dependencies using `npm install` +3. Create a `env.js` file and copy the contents of `env.sample.js` to it, replace the `token` and/or the `baseUrl` with your own gitlab instance configurations. + - you can create a personal access token from your gitlab settings and make sure to allow `api`, `read_user`, `read_repository` and `read_registry` access for that token. +4. Start a server from the project directory, the project should now be running in your browser, this project uses [snowpack](https://www.snowpack.dev/) so no building/bundling is required. + +## Workflow: +- as mentioned above make sure to create an issue or grab an existing one from [here](https://github.com/ahmadalfy/gitlab-explorer/issues) +- create a branch from `master` branch, make sure that your naming convention matches `[type]/[name]`, replace the `type` with one of `feature / fix / hotfix`. +- make changes and use [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) to format your commits messages. +- push your changes to your fork and create a PR on the main repo, make sure you provide a good description of your changes in the PR body and attach screenshots to any UI/UX changes you make. +- Wait for your PR to be reviewed and merged. From 81e2a8fc22391d236e6593bfa4d2bb32d0e016f5 Mon Sep 17 00:00:00 2001 From: Ali Hassan Date: Mon, 3 Feb 2020 20:12:38 +0200 Subject: [PATCH 2/3] chore: moved the getting started info to the README and created a link to it from CONTRIBUTION.md --- CONTRIBUTION.md | 8 +------- README.md | 10 ++++++---- 2 files changed, 7 insertions(+), 11 deletions(-) diff --git a/CONTRIBUTION.md b/CONTRIBUTION.md index 16efcad..dcb751d 100644 --- a/CONTRIBUTION.md +++ b/CONTRIBUTION.md @@ -2,13 +2,7 @@ When contributing to this repository , first make sure to discuss the change you wish to make via an [issue](https://github.com/ahmadalfy/gitlab-explorer/issues) ## Installation: -### Note: make sure to use the latest version of Chrome and enable the experamintal javascript flag from `chrome://flags`, this is important since some of the javascript used here are still not official yet. - -1. Fork this repo and clone that fork from your account to your local machine. -2. Install the dependencies using `npm install` -3. Create a `env.js` file and copy the contents of `env.sample.js` to it, replace the `token` and/or the `baseUrl` with your own gitlab instance configurations. - - you can create a personal access token from your gitlab settings and make sure to allow `api`, `read_user`, `read_repository` and `read_registry` access for that token. -4. Start a server from the project directory, the project should now be running in your browser, this project uses [snowpack](https://www.snowpack.dev/) so no building/bundling is required. +- [Follow These Steps](./README.md#getting-started) to get the project running on your machine. ## Workflow: - as mentioned above make sure to create an issue or grab an existing one from [here](https://github.com/ahmadalfy/gitlab-explorer/issues) diff --git a/README.md b/README.md index 6f9d409..4ff612a 100644 --- a/README.md +++ b/README.md @@ -17,10 +17,12 @@ Since everything is stored in your browser, you might want to export the data so ## Getting started -1. Clone the repository. -2. Create an access token from your [gitlab settings](https://gitlab.com/profile/personal_access_tokens). You need to grant it access to `api`, `read_user`, `read_repository` and `read_registry`. -3. Copy the `env.sample.js` file to `env.js` and replace the default empty string for token option with your token (for self-hosted servers change the baseUrl option to match your domain). -4. Use an http server to run the application. There's no build steps required and you don't even need to install the required modules. +### Note: make sure to use the latest version of Chrome and enable the experamintal javascript flag from `chrome://flags`, this is important since some of the javascript used here are still not official yet. + +1. Install the dependencies using `npm install` +2. Create a `env.js` file and copy the contents of `env.sample.js` to it, replace the `token` and/or the `baseUrl` with your own gitlab instance configurations. + - you can create a personal access token from your gitlab settings and make sure to allow `api`, `read_user`, `read_repository` and `read_registry` access for that token. +3. Start a server from the project directory, the project should now be running in your browser, this project uses [snowpack](https://www.snowpack.dev/) so no building/bundling is required. ## Future plans From 93caec51ac2ad566425f3e6cfaeae07ecc0a1022 Mon Sep 17 00:00:00 2001 From: Ali Hassan Date: Mon, 3 Feb 2020 20:26:26 +0200 Subject: [PATCH 3/3] chore: fixing liniting issues and removing npm install step as deemed un-needed --- CONTRIBUTION.md | 23 +++++++++++++++-------- README.md | 9 ++++----- 2 files changed, 19 insertions(+), 13 deletions(-) diff --git a/CONTRIBUTION.md b/CONTRIBUTION.md index dcb751d..805167f 100644 --- a/CONTRIBUTION.md +++ b/CONTRIBUTION.md @@ -1,12 +1,19 @@ # Contributing + When contributing to this repository , first make sure to discuss the change you wish to make via an [issue](https://github.com/ahmadalfy/gitlab-explorer/issues) -## Installation: -- [Follow These Steps](./README.md#getting-started) to get the project running on your machine. +## Installation + +* [Follow These Steps](./README.md#getting-started) to get the project running on your machine. + +## Workflow + +* as mentioned above make sure to create an issue or grab an existing one from [here](https://github.com/ahmadalfy/gitlab-explorer/issues) + +* create a branch from `master` branch, make sure that your naming convention matches `[type]/[name]`, replace the `type` with one of `feature / fix / hotfix`. + +* make changes and use [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) to format your commits messages. + +* push your changes to your fork and create a PR on the main repo, make sure you provide a good description of your changes in the PR body and attach screenshots to any UI/UX changes you make. -## Workflow: -- as mentioned above make sure to create an issue or grab an existing one from [here](https://github.com/ahmadalfy/gitlab-explorer/issues) -- create a branch from `master` branch, make sure that your naming convention matches `[type]/[name]`, replace the `type` with one of `feature / fix / hotfix`. -- make changes and use [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) to format your commits messages. -- push your changes to your fork and create a PR on the main repo, make sure you provide a good description of your changes in the PR body and attach screenshots to any UI/UX changes you make. -- Wait for your PR to be reviewed and merged. +* Wait for your PR to be reviewed and merged. diff --git a/README.md b/README.md index 4ff612a..e5d46d8 100644 --- a/README.md +++ b/README.md @@ -17,12 +17,11 @@ Since everything is stored in your browser, you might want to export the data so ## Getting started -### Note: make sure to use the latest version of Chrome and enable the experamintal javascript flag from `chrome://flags`, this is important since some of the javascript used here are still not official yet. +**Note: make sure to use the latest version of Chrome and enable the experamintal javascript flag from `chrome://flags`, this is important since some of the javascript used here are still not official yet** -1. Install the dependencies using `npm install` -2. Create a `env.js` file and copy the contents of `env.sample.js` to it, replace the `token` and/or the `baseUrl` with your own gitlab instance configurations. - - you can create a personal access token from your gitlab settings and make sure to allow `api`, `read_user`, `read_repository` and `read_registry` access for that token. -3. Start a server from the project directory, the project should now be running in your browser, this project uses [snowpack](https://www.snowpack.dev/) so no building/bundling is required. +1. Create a `env.js` file and copy the contents of `env.sample.js` to it, replace the `token` and/or the `baseUrl` with your own gitlab instance configurations. + * you can create a personal access token from your gitlab settings and make sure to allow `api`, `read_user`, `read_repository` and `read_registry` access for that token. +2. Start a server from the project directory, the project should now be running in your browser, this project uses [snowpack](https://www.snowpack.dev/) so no building/bundling is required. ## Future plans