|
1 | | -# Cerebra |
2 | | - |
3 | | -This monorepo starter was created by **Aamogh Sawant** to help future tech directors and developers streamline their projects with a structured, scalable setup. |
4 | | - |
5 | | -## Getting Started |
6 | | - |
7 | | -Set up your project by running: |
8 | | -```sh |
9 | | -npx create-turbo@latest -e with-tailwind |
10 | | -``` |
11 | | - |
12 | | -This creates a fully functional, TypeScript-based monorepo with Tailwind CSS and ready-to-use tooling. |
13 | | - |
14 | | -## What's Inside? |
15 | | - |
16 | | -This monorepo includes several apps and packages designed to accelerate development. |
17 | | - |
18 | | -### Apps and Packages |
19 | | - |
20 | | -**hacklytics** — A Next.js application with Tailwind CSS for documentation, guides, or internal knowledge sharing. (WILL BE CONVERTING TO REACT AND VITE) |
21 | | - |
22 | | -**web** — Another Next.js application with Tailwind CSS for your main website or internal dashboards. (WILL BE CONVERTING TO REACT AND VITE) |
23 | | - |
24 | | -**ui** — A shared React component library with Tailwind CSS for reusing UI components across apps. All classes are prefixed with `ui-` to avoid conflicts. |
25 | | - |
26 | | -**@repo/eslint-config** — Centralized ESLint configuration, including `eslint-config-next` and `eslint-config-prettier` for consistent linting. |
27 | | - |
28 | | -**@repo/typescript-config** — Pre-configured TypeScript settings for all apps and packages. |
29 | | - |
30 | | -Everything is built with TypeScript for type safety and maintainable code. |
31 | | - |
32 | | -## Building UI Components |
33 | | - |
34 | | -The `ui` package produces compiled styles in the `dist` directory. Next.js apps consume these components using `transpilePackages` in `next.config.ts`. |
35 | | - |
36 | | -### Key Benefits |
37 | | - |
38 | | -- Easy sharing of a single `tailwind.config.ts` across apps and packages |
39 | | -- Simple package compilation with minimal dependencies |
40 | | -- Tailwind CSS class isolation (`ui-` prefix prevents overwriting) |
41 | | -- Clear package boundaries and maintainable exports |
42 | | - |
43 | | -### Alternative: Consuming from Source |
44 | | - |
45 | | -You can consume `ui` components directly from source without building. Update your apps' `tailwind.config.ts`: |
46 | | -```ts |
47 | | -content: [ |
48 | | - // app content |
49 | | - `src/**/*.{js,ts,jsx,tsx}`, |
50 | | - // include packages if consuming from source |
51 | | - "../../packages/ui/*.{js,ts,jsx,tsx}", |
52 | | -] |
53 | | -``` |
54 | | - |
55 | | -If using this approach, remove `tailwindcss` and `autoprefixer` from the `ui` package. |
56 | | - |
57 | | -## Utilities Included |
58 | | - |
59 | | -This monorepo comes pre-configured with: |
60 | | - |
61 | | -- **Tailwind CSS** — Modern, responsive styling |
62 | | -- **TypeScript** — Static type safety |
63 | | -- **ESLint** — Consistent code quality |
64 | | -- **Prettier** — Automatic code formatting |
65 | | - |
66 | | -## Questions? |
67 | | - |
68 | | -Feel free to reach out or contribute to improve this starter for the DSGT community. |
| 1 | +## uh |
0 commit comments