Skip to content

Commit

Permalink
public repo creation for open-sourcing
Browse files Browse the repository at this point in the history
  • Loading branch information
aliyamohamed13 committed Jul 16, 2020
0 parents commit c2871cc
Show file tree
Hide file tree
Showing 731 changed files with 146,663 additions and 0 deletions.
38 changes: 38 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: ''
assignees: ''

---

**Describe the bug**
A clear and concise description of what the bug is.

**To Reproduce**
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

**Expected behavior**
A clear and concise description of what you expected to happen.

**Screenshots**
If applicable, add screenshots to help explain your problem.

**Desktop (please complete the following information):**
- OS: [e.g. iOS]
- Browser [e.g. chrome, safari]
- Version [e.g. 22]

**Smartphone (please complete the following information):**
- Device: [e.g. iPhone6]
- OS: [e.g. iOS8.1]
- Browser [e.g. stock browser, safari]
- Version [e.g. 22]

**Additional context**
Add any other context about the problem here.
10 changes: 10 additions & 0 deletions .github/ISSUE_TEMPLATE/custom.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
name: Custom issue template
about: Describe this issue template's purpose here.
title: ''
labels: ''
assignees: ''

---


20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: Feature request
about: Suggest an idea for this project
title: ''
labels: ''
assignees: ''

---

**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

**Describe the solution you'd like**
A clear and concise description of what you want to happen.

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.

**Additional context**
Add any other context or screenshots about the feature request here.
8 changes: 8 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
.idea
node_modules
lerna-debug.log
packages/api/coverage
packages/api/.env.local
packages/webapp/cypress/videos
packages/webapp/cypress/screenshots
.vscode
66 changes: 66 additions & 0 deletions .gitlab-ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
# This is the yml file for our CI configuration in GitLab
image: cypress/browsers:chrome69

services:
- postgres:latest

variables:
POSTGRES_DB: mock_farm
POSTGRES_USER: postgres
POSTGRES_PASSWORD: "postgres"

stages:
- test
- deploy webapp to integration
- deploy api to integration
- deploy webapp to production
- deploy api to production

.test:
stage: test
script:
- npm install knex -g
- cd packages/webapp && npm install
- npm run test
- npm run cypress-gitlab
- npm run lint
- cd ../api && npm install
- knex migrate:rollback --env ci && knex migrate:latest --env ci && knex seed:run --env ci
- npm run ci
- npm run lint

deploy webapp to integration:
stage: deploy webapp to integration
script:
- git checkout develop
- git remote add heroku https://heroku:[email protected]/litefarm-webapp-integration.git
- git push heroku `git subtree split --prefix packages/webapp develop`:refs/heads/master --force
only:
- develop

deploy api to integration:
stage: deploy api to integration
script:
- git checkout develop
- git remote add heroku https://heroku:[email protected]/litefarm-api-integration.git
- git push heroku `git subtree split --prefix packages/api develop`:refs/heads/master --force
only:
- develop

deploy webapp to production:
stage: deploy webapp to production
script:
- git checkout master
- git remote add heroku https://heroku:[email protected]/litefarm-webapp-production.git
- git push heroku `git subtree split --prefix packages/webapp master`:refs/heads/master --force
only:
- master

deploy api to production:
stage: deploy api to production
script:
- git checkout master
- git remote add heroku https://heroku:[email protected]/litefarm-api-production.git
- git push heroku `git subtree split --prefix packages/api master`:refs/heads/master --force
only:
- master
74 changes: 74 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
# Contributor Covenant Code of Conduct

## Our Pledge

In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to making participation in our project and
our community a harassment-free experience for everyone, regardless of age, body
size, disability, ethnicity, sex characteristics, gender identity and expression,
level of experience, education, socio-economic status, nationality, personal
appearance, race, religion, or sexual identity and orientation.

## Our Standards

Examples of behavior that contributes to creating a positive environment
include:

* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

* The use of sexualized language or imagery and unwelcome sexual attention or
advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic
address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting

## Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable
behavior and are expected to take appropriate and fair corrective action in
response to any instances of unacceptable behavior.

Project maintainers have the right and responsibility to remove, edit, or
reject comments, commits, code, issues, and other contributions
that are not aligned to this Code of Conduct, or to ban temporarily or
permanently any contributor for other behaviors that they deem inappropriate,
threatening, offensive, or harmful.

## Scope

This Code of Conduct applies both within project spaces and in public spaces
when an individual is representing the project or its community. Examples of
representing a project or community include using an official project e-mail
address, posting via an official social media account, or acting as an appointed
representative at an online or offline event. Representation of a project may be
further defined and clarified by project maintainers.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting one or more of the project maintainers. All complaints
will be reviewed and investigated and will result in a response that is deemed
necessary and appropriate to the circumstances. The project team is obligated to
maintain confidentiality with regard to the reporter of an incident. Further
details of specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good
faith may face temporary or permanent repercussions as determined by other
members of the project's leadership.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
available [here][source].

[homepage]: https://www.contributor-covenant.org
[source]: https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
38 changes: 38 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
## Contributing

Thank you for considering contributing to LiteFarm.

### Where do I go from here?

If you have noticed a bug in the application or have a feature request, please create an issue on [github](https://github.com/juice-tn/litefarm/issues/new).

### Fork & create a branch

If this is something you think you can fix, then you can fork the repo and create
a branch with a descriptive name. The branch should be based off of the develop branch.

A good branch name would be:

```sh
git checkout -b 12-add-portuguese-translations
```

(where issue #12 is the ticket you're working on)

### Get the app running

Instructions for getting the app running on your local machine can be found in the [README](https://github.com/juice-tn/LiteFarm/blob/master/README.md).

### Implement your fix or feature and view your changes

Please view the updates in your browser to confirm your changes.

### Confirm that all tests and linters pass

Before making a pull request, all test suites and linters for the client-facing web application and the backend API should pass. Instructions for running the tests can be found in the [README](https://github.com/juice-tn/LiteFarm/blob/master/README.md).

### Make a Pull Request

We are currently following the [gitflow](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow) workflow. Once you have confirmed your changes in the browser and checked that all
tests are passing, a pull request can be made to the develop branch. The app will will also run through a CI pipeline which runs all tests and linters once
a pull request is made.
Loading

0 comments on commit c2871cc

Please sign in to comment.