Skip to content

Commit

Permalink
create monorepo
Browse files Browse the repository at this point in the history
  • Loading branch information
brandonfcohen1 committed Aug 31, 2023
1 parent c47a492 commit 1ee196b
Show file tree
Hide file tree
Showing 56 changed files with 4,631 additions and 4 deletions.
41 changes: 39 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,4 +1,41 @@
## Data
/notebooks/.ipynb_checkpoints/
.idea
src/tmp
.DS_Store
data/src/tmp
.DS_Store

## App

# dependencies
/node_modules
/.pnp
.pnp.js

# testing
/coverage

# next.js
/.next/
/out/

# production
/build

# misc
.DS_Store
*.pem

# debug
npm-debug.log*
yarn-debug.log*
yarn-error.log*

# local env files
.env*.local

# vercel
.vercel

# typescript
*.tsbuildinfo
next-env.d.ts
28 changes: 26 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,14 @@ In September, we hope to begin turning our attention to building the dashboard a
- Tailwind
- Python (data engineering)

### Codebase

This is a monorepo for both the nextjs app and the scripts which ETL and analyze the data.

## Data Scripts

All of the data scripting is in python and lives in the `data` folder. Everything below should be run in that folder.

# Setup Instructions

1. Install [pyenv](https://github.com/pyenv/pyenv) (or [pyenv-win](https://github.com/pyenv-win/pyenv-win) for Windows) for Python version management
Expand All @@ -66,7 +74,7 @@ In `/config/config`, set `FORCE_RELOAD` = `False` to read "cached" data in postg

# awkde

We are using the [awkde package](https://github.com/mennthor/awkde) to create the Adaptive Width KDE. It is not available through pip. To install, navigate to `src/awkde` and run
We are using the [awkde package](https://github.com/mennthor/awkde) to create the Adaptive Width KDE. It is not available through pip. To install, navigate to `src` and run

```
pip install -e ./awkde
Expand All @@ -82,7 +90,23 @@ pip install -e ./awkde

To upload to Mapbox through the API you'll need a key with `upload` write access, saved to the environment variable `CFP_MAPBOX_TOKEN_UPLOADER`

# Contribution Instructions
## Nextjs App

Install dependencies with:

```bash
npm i --legacy-peer-deps
```

First, run the development server:

```bash
npm run dev
```

Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.

## Contribution Instructions

1. Create a fork of this repository and work from branches within your fork. When those changes are ready for review, create a pull request from fork:branch to upstream:main
2. Before committing changes, format your code to maintain a consistent codebase:
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
4 changes: 4 additions & 0 deletions next.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
/** @type {import('next').NextConfig} */
const nextConfig = {}

module.exports = nextConfig
Loading

0 comments on commit 1ee196b

Please sign in to comment.