• [Badges] [ Todo ]

Intro

GitPaid is an application designed to make tracking the details of your job hunt easier. [ Expand ]

• Video Demo/Micro Gif Demos/Screen Shots [ Todo ]

---

Table of content

• Installation
  • Document the installation process -Contributing
  • Doucment how someone can contribute to the project
  • Document the tech stack we are using
  • Provide code samples where necessary
  • Why we are using the stack we are?
  • ERD Diagram
    • Lucid chart has an import option.
• Future plans
• FAQ
  • How to add a new Github Issue?
  • How do I request a feature?
• License
  • MIT

---

Installation

• Fork and clone this repository.
• Run npm install to install the dependencies.
• Run the following commands in your console to setup the database.

createdb gitpaid_dev
createdb gitpaid_test
npm run knex migrate:latest
npm run knex seed:run

There are a few environment variables that you also need to configure.

• Set HOST=http://localhost:8000
• Create a LinkedIn OAuth application by going here.
• • When creating this application, set the "Authorized redirect URL" to be http://localhost:8000/auth/linkedin/callback
• • Set both the Default "Accept" Redirect URL and the Default "Cancel" Redirect URL to be: http://localhost:8000/
• • Store the client id and secret in your .env file as LINKEDIN_CLIENT_ID and LINKEDIN_CLIENT_SECRET
• Set a JWT_SECRET variable using this command: bash -c 'echo "JWT_SECRET="$(openssl rand -hex 64)' >> .env

---

Contributing

We are happy and welcome those who wish to contribute to GitPaid.

Head over to our Issues page and take a look through our open issues. Feel free to join the discussion and provide your input. If you would like to takle one of the issues just leave a comment Where we can use help^ Pull requests are very much welcome for the following.

Bugs 🐞

If you have come across a bug while using the app please file a bug report over on our Issues page. Try to provide as much information as possible about what you were doing when the bug occured and Be sure to add the "bug" label to your report.

If you are looking to make code contributions, fixing bugs filed in Issues is a good place to start.

Adding tests

[ Todo ]

Writing documentation

Let's face it, documentation is never as good as it could be or alwys up-to-date. If you find something lacking or out-of-date in our documentation feel free to chime in. You can either create an Issue with the "documentation" label, or make a pull request with the changes.

Making a Pull Request

In order to make a pull request you will first need to setup GitPaid on your machine. [ Expand ]

---

Future Plans

[ Todo ]

---

FAQ

How do I add a new Issue?

Head over to our Issues page. [ Expand ]

How do I make a feature request?

Head over to our Issues page and use the "feature request" label. [ Expand ]

---

License

MIT [ Todo ]