Merge pull request #176 from umjennifer/update-documentation

Update documentation

CONTRIBUTING.md

@@ -1,33 +1,60 @@
-## Submitting changes
-
-- Fork the repo
-- Clone the forked repo
- ```
- $ git clone FORKED_REPO
- ```
-- Install the dependencies
- ```
- $ yarn install
- ```
-- Check out a new branch based and name it to what you intend to do:
- ```
- $ git checkout -b BRANCH_NAME
- ```
-- Run the project
- ```
- $ yarn dev
- ```
-- Commit your changes
- - Please provide a git message that explains what you've done
- - Commit to the forked repository
- ```
- $ git commit -am 'Add some proper message'
- ```
-- Push to the branch
- ```
- $ git push origin BRANCH_NAME
- ```
-- Make a pull request
- - Make sure you send the PR to the <code>main</code> branch
-
-Once done, our developer will review the changes and merge to <code>main</code> branch
+# Contributing
+
+Review the [Code of Conduct](CODE_OF_CONDUCT.md).
+
+## Where to start
+View [issues tagged with the *Good First Issues* label](https://github.com/sadanandpai/resume-builder/labels/good%20first%20issue) to find good first feature requests and bugs to fix.
+
+Visit https://github.com/sadanandpai/resume-builder/issues to view all issues.
+
+--- 
+
+## Development
+
+### Running the environment locally or in Docker
+
+Run the environment locally or in Docker by following the instructions at [Running the environment](RUN_ENVIRONMENT.MD).
+
+---
+
+### Creating a template
+
+TODO(sadanandpai): Per issue https://github.com/sadanandpai/resume-builder/issues/175, add instructions for how to create a template.
+
+---
+
+### Submit a change
+
+1. [Fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo) the repo.
+1. [Clone](https://docs.github.com/en/get-started/quickstart/fork-a-repo) the forked repo.
+ ```
+ $ git clone FORKED_REPO
+ ```
+1. Install the dependencies
+ ```
+ $ yarn install
+ ```
+1. Check out a new branch based and name it to what you intend to do:
+ ```
+ $ git checkout -b BRANCH_NAME
+ ```
+1. Run the project
+ ```
+ $ yarn dev
+ ```
+1. Commit your changes
+
+ 1. [Commit](https://github.com/git-guides/git-commit) to the forked repository
+ ```
+ $ git commit -am 'Add some proper message'
+ ```
+
+ Please provide a git message that explains what you've done.
+
+ 1. [Push](https://github.com/git-guides/git-push) to the branch
+ ```
+ $ git push origin BRANCH_NAME
+ ```
+ 1. Make a [pull request](https://github.com/git-guides/git-pull) (PR). Ensure you send the PR to the `main` branch
+
+ Once done, our developer will review the changes and merge to `main` branch.

README.md

@@ -1,11 +1,12 @@
 <div align="center">
-<h1>Resume Builder</h1>
+
+# Resume Builder
 
 ### Free and open source, fully customizable professional single page resume builder
 
 <a href="https://e-resume.vercel.app/"><img src="https://user-images.githubusercontent.com/12962887/201484876-75290af9-ccd6-4f6d-be96-6a8fb4f20c4b.png" alt="get started with resume builder" height="200" widdth="330" />
 
-<a href="https://e-resume.vercel.app">Resume builder</a>
+https://e-resume.vercel.app
 
 [![](https://img.shields.io/github/stars/sadanandpai/single-page-resume-builder?style=for-the-badge)](#stars)
 [![](https://img.shields.io/github/forks/sadanandpai/single-page-resume-builder?style=for-the-badge)](#forks)
@@ -21,7 +22,9 @@
 
 [Resume Builder](https://e-resume.vercel.app) is an open source application where one can effectively build a single page professional resume.
 
-Here are some reasons you should utilise this resume builder:
+Visit our [User Guide](USER_GUIDE.md) to start building!
+
+Features:
 
 - Customise with templates and themes!
 - Simple interface that helps you build quicky!
@@ -30,26 +33,22 @@ Here are some reasons you should utilise this resume builder:
 
 > Disclaimer: In order to enhance the vision and usage, we are shadowing our user's interactions. This is solely performed to serve you better
 
-<br>
-
-## Developer Guide
+Learn more about our design in the [*E-Resume — Build a professional resume: Design case study* Medium post.](https://uxplanet.org/e-resume-build-a-professional-resume-design-case-study-3dc02a6359ea)
 
-If you want to run the resume builder application in your local, please refer to [Developer Guide](./DEVELOPER.md).
+## Contributing Guide
 
-<br>
+If you are interested in contributing (fixing bugs, impoving features, or creating a resume template), please refer to [Contributing Guide](./CONTRIBUTING.md).
 
-## Contributing Guide
+## Report Bugs and Feature Requests
 
-If you are a developer and would like to contribute to resume builder by fixing the bugs, impoving the features or creating a resume template, please refer to [Contributing Guide](./CONTRIBUTING.md).
+File a [bug report](https://github.com/sadanandpai/resume-builder/issues/new?assignees=sadanandpai&labels=&template=bug_report.md&title=) or [feature request](https://github.com/sadanandpai/resume-builder/issues/new?assignees=sadanandpai&labels=&template=feature_request.md&title=) using the [New Issues](https://github.com/sadanandpai/resume-builder/issues/new/choose) page. 
 
-<br>
+[View all issues.](https://github.com/sadanandpai/resume-builder/issues)
 
-## Core contributors
+## Core Contributors
 
 <a href="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/sadanandpai"><img src="https://avatars.githubusercontent.com/u/12962887" alt="sadanand" height="75px" width="75px" /></a> <a href="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/gopal1996"><img src="https://avatars.githubusercontent.com/u/22369081" alt="sadanand" height="75px" width="75px" /></a> <a href="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/yakshaG"><img src="https://avatars.githubusercontent.com/u/26523871" alt="sadanand" height="75px" width="75px" /></a> <a href="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/siva-kannan3"><img src="https://avatars.githubusercontent.com/u/60533560" alt="sadanand" height="75px" width="75px" /></a>
 
-<br>
-
 ## License
 
-This repository is MIT licensed. [Read more](./LICENSE)
+This repository is [MIT licensed](./LICENSE).

RUN_ENVIRONMENT.MD

@@ -0,0 +1,44 @@
+### Running the environment
+
+#### Running in local
+1. Open the terminal / command prompt in your system
+1. Clone the repo
+ ```
+ $ git clone https://github.com/sadanandpai/resume-builder.git
+ ```
+1. Install the dependencies
+ ```
+ $ yarn install
+ ```
+ or
+
+ ```
+ $ npm install
+ ```
+1. Run the project
+
+ ```
+ $ yarn dev
+ ```
+
+ or
+
+ ```
+ $ npm run dev
+ ```
+1. Visit http:https://localhost:3000/ on your browser
+
+### Run via Docker
+
+Prequisite: Install [Docker](https://docs.docker.com/engine/install/). 
+
+1. Open the terminal / command prompt in your system
+1. Clone the repo
+ ```
+ $ git clone https://github.com/sadanandpai/resume-builder.git
+ ```
+1. Run the below command in the terminal from within the cloned project directory
+
+ ```
+ $ docker-compose up -d
+ ```

USER_GUIDE.md

@@ -0,0 +1,24 @@
+# Resume Builder User Guide
+
+Resume Builder works best on a desktop.
+
+## Building a Resume
+
+1. Visit https://e-resume.vercel.app/
+1. Select "Editor" in the top pane
+1. Select "TEMPLATES" in the top pane and select your desired template
+1. Select "COLOURS" in the top pane and select your desired color scheme
+1. Update the sections in the right pane with your experience
+1. When you're done, 
+ - Export your data by selecting "Export" in the top pane. This will generate a JSON file that gets downloaded to your local device. Save this file for later use.
+ - Download the resume as a PDF by selecting "DOWNLOAD AS PDF" in the top pane
+
+## Editing a Resume
+1. Visit https://e-resume.vercel.app/
+1. Select "Editor" in the top pane
+1. Select "Import in the top pane". Import the JSON that was generated in the [Building a Resume](#building-a-resume) section.
+
+
+## Running the environment locally or in Docker
+
+Run the environment locally or in Docker by following the instructions at [Running the environment](RUN_ENVIRONMENT.MD).