Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
dan-cooke authored Oct 20, 2023
1 parent b80951a commit 7c94f21
Showing 1 changed file with 8 additions and 69 deletions.
77 changes: 8 additions & 69 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,73 +1,12 @@
# Turborepo starter
# Baggers
This project consumed many many years of my life - and it opened many doors for me. It was maybe a solution in search of a problem - but I loved working on it.

This is an official npm starter turborepo.
## Why is this public?
I consider this project to be some of my best work, and its a shame that it is just sitting in a private Github repo gathering dust. I get a lot of DM's asking for examples of X and Y and I always end up sending snippets from this repo. So better to just make it public for ease of sharing.

## What's inside?
## What is Baggers?
Baggers was my attempt at creating [Grafana](https://grafana.com/) for the stock market (at least thats how I sell it to other devs). But it was really my amateur attempt at creating a bloomberg terminal for the web. The vision was to have a rich data driven UI that allowed users to create custom visualisations of the stock market, as well as track and monitor their portfolios. I ran out of steam towards the end purely because I couldn't find a market fit for it, I think the vision i had was something that I (an amateur investor) wanted, but in reality the pro's already have solutions they are very satisfied with.

This turborepo uses [npm](https://www.npmjs.com/) as a package manager. It includes the following packages/apps:
I think its sad at the end of the day that something that I worked on purely for fun was usurped by my desire to monetize it.

### Apps and Packages

- `docs`: a [Next.js](https://nextjs.org/) app
- `web`: another [Next.js](https://nextjs.org/) app
- `ui`: a stub React component library shared by both `web` and `docs` applications
- `eslint-config-custom`: `eslint` configurations (includes `eslint-config-next` and `eslint-config-prettier`)
- `tsconfig`: `tsconfig.json`s used throughout the monorepo

Each package/app is 100% [TypeScript](https://www.typescriptlang.org/).

### Utilities

This turborepo has some additional tools already setup for you:

- [TypeScript](https://www.typescriptlang.org/) for static type checking
- [ESLint](https://eslint.org/) for code linting
- [Prettier](https://prettier.io) for code formatting

### Build

To build all apps and packages, run the following command:

```
cd my-turborepo
npm run build
```

### Develop

To develop all apps and packages, run the following command:

```
cd my-turborepo
npm run dev
```

### Remote Caching

Turborepo can use a technique known as [Remote Caching](https://turbo.build/repo/docs/core-concepts/remote-caching) to share cache artifacts across machines, enabling you to share build caches with your team and CI/CD pipelines.

By default, Turborepo will cache locally. To enable Remote Caching you will need an account with Vercel. If you don't have an account you can [create one](https://vercel.com/signup), then enter the following commands:

```
cd my-turborepo
npx turbo login
```

This will authenticate the Turborepo CLI with your [Vercel account](https://vercel.com/docs/concepts/personal-accounts/overview).

Next, you can link your Turborepo to your Remote Cache by running the following command from the root of your turborepo:

```
npx turbo link
```

## Useful Links

Learn more about the power of Turborepo:

- [Pipelines](https://turbo.build/repo/docs/core-concepts/monorepos/running-tasks)
- [Caching](https://turbo.build/repo/docs/core-concepts/caching)
- [Remote Caching](https://turbo.build/repo/docs/core-concepts/remote-caching)
- [Filtering](https://turbo.build/repo/docs/core-concepts/monorepos/filtering)
- [Configuration Options](https://turbo.build/repo/docs/reference/configuration)
- [CLI Usage](https://turbo.build/repo/docs/reference/command-line-reference)
At the end of the day, I learnt a lot from this project - technically speaking and from a motivational sense. I think the headline for me is "if you plan to monetize something, make sure you understand your user and problem space first, otherwise do it for fun and make it open source"

0 comments on commit 7c94f21

Please sign in to comment.