Skip to content

Commit

Permalink
clean up; merge identical queries
Browse files Browse the repository at this point in the history
  • Loading branch information
arthtyagi committed Oct 26, 2022
1 parent 79180f5 commit 094a665
Show file tree
Hide file tree
Showing 4 changed files with 24 additions and 26 deletions.
29 changes: 13 additions & 16 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,31 +16,28 @@ For instructions on how to run the server, see [server/README.md](apps/server/re

### Server

- **Option 1: Poetry**:
- **Option 1: Poetry**:

To use multiple versions of Python, you can use `pyenv`:
3.10.6 is an example for our use-case.

- Install `pyenv` using `brew`.
- `pyenv install 3.10.6`.
- Launch shell - `pyenv shell 3.10.6`.
- Install `pyenv` using `brew`.
- `pyenv install 3.10.6`.
- Launch shell - `pyenv shell 3.10.6`.

Install Poetry: [Read more here](https://python-poetry.org/docs/)
Install Poetry: [Read more here](https://python-poetry.org/docs/)

1. `poetry config virtualenvs.in-project true`
2. `poetry self update` to update to the latest version of Poetry.
3. If you used, `pyenv shell`, you can now run `poetry env use python3.10.6`.
4. `poetry install` to install all dependencies.
5. `poetry export --without-hashes --format=requirements.txt > requirements.txt` to export the requirements without hashes.
1. `poetry config virtualenvs.in-project true`
2. `poetry self update` to update to the latest version of Poetry.
3. If you used, `pyenv shell`, you can now run `poetry env use python3.10.6`.
4. `poetry install` to install all dependencies.
5. `poetry export --without-hashes --format=requirements.txt > requirements.txt` to export the requirements without hashes.

- **Option 2: Docker**:
- **Option 2: Docker**:

- Docker is cool, however, I'd recommend not launching a resource-heavy container every time you want to run a development server.
1. Install Docker: [Read more here](https://www.docker.com/community-edition)
2. `docker-compose build` to build the Docker image.
3. `docker-compose up` to start the server.
- Docker is cool, however, I'd recommend not launching a resource-heavy container every time you want to run a development server. 1. Install Docker: [Read more here](https://www.docker.com/community-edition) 2. `docker-compose build` to build the Docker image. 3. `docker-compose up` to start the server.

- **Make sure to use the pre-commit hook**
- **Make sure to use the pre-commit hook**
1. Installation - [Read more here](https://pre-commit.com)
2. `pre-commit install` to install the pre-commit hooks.
3. `pre-commit run -a` to run the pre-commit hooks.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,19 +21,19 @@

### Apps

- [app/landing](https://github.com/DevClad-Inc/devclad-client/tree/main/apps/landing)
- [app/web](https://github.com/DevClad-Inc/devclad-client/tree/main/apps/web)
- [app/landing](https://github.com/DevClad-Inc/devclad-client/tree/main/apps/landing)
- [app/web](https://github.com/DevClad-Inc/devclad-client/tree/main/apps/web)

---

## Contributing

## Styling

- Tabs not spaces. Tabs are 4 spaces.
- (Exception: server code which uses Python with `black` formatting)
- Use `prettier` for formatting.
- Using [Airbnb Style Guide](https://github.com/airbnb/javascript) for ESLint with some modifications.
- Tabs not spaces. Tabs are 4 spaces.
- (Exception: server code which uses Python with `black` formatting)
- Use `prettier` for formatting.
- Using [Airbnb Style Guide](https://github.com/airbnb/javascript) for ESLint with some modifications.

## Absolute Imports

Expand Down
8 changes: 4 additions & 4 deletions apps/server/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@

## Database and Async

- PostgresQL (in prod only)
- Redis for caching and async tasks.
- Channel layer for websocket communication.
- Celery for scheduling async tasks.
- PostgresQL (in prod only)
- Redis for caching and async tasks.
- Channel layer for websocket communication.
- Celery for scheduling async tasks.

## Code Formatting

Expand Down
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
"@devclad/config": "*",
"@devclad/ui": "*",
"prettier": "^2.7.1",
"prettier-plugin-tailwindcss": "^0.1.13",
"turbo": "1.6.1"
},
"engines": {
Expand Down

2 comments on commit 094a665

@vercel
Copy link

@vercel vercel bot commented on 094a665 Oct 26, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

devclad-landing – ./apps/landing

devclad-landing.vercel.app
devclad-landing-devclad.vercel.app
devclad-landing-git-main-devclad.vercel.app
www.devclad.com
devclad.com

@vercel
Copy link

@vercel vercel bot commented on 094a665 Oct 26, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

devclad-web – ./apps/web

devclad-web-devclad.vercel.app
devclad-web-git-main-devclad.vercel.app
devclad-client-landing.vercel.app

Please sign in to comment.