|
1 | | -# Astro Starter Kit: Basics |
| 1 | +🧹 `Cascarilla.js: The Vibes Library` 🧅 |
| 2 | +============================================== |
2 | 3 |
|
3 | | -```sh |
4 | | -npm create astro@latest -- --template basics |
| 4 | +🤙✨ Give Your Website Good Vibes and Aché 🤙✨ |
| 5 | + |
| 6 | +Cascarilla.js is a library that brings good vibes and aché to your website, setting you up for success from the start 🌟. By simply importing this library, you'll be starting your project on the right foot 😉. |
| 7 | + |
| 8 | +With Cascarilla.js, you automatically get: |
| 9 | + |
| 10 | +- 🏗️ Less Build Errors 🙌. |
| 11 | + |
| 12 | +- 💥 Fewer Server Crashes. Keep your servers running smoothly, all the time 🕒. |
| 13 | + |
| 14 | +- 🧘♂️ Almost No Linting Frustrations. Less stress, more coding joy 😌. |
| 15 | + |
| 16 | +- 💣 No Production Halts. Keep your production environment running 💻. |
| 17 | + |
| 18 | +- 👥 Be part of the Coolest of Cuban Developers 👥. |
| 19 | + |
| 20 | +By using Cascarilla.js your projects will be blessed with good vibes from the start, and you will have rest easily knowing that everything will just be fine. You'll be part of an amazing group of developers also using Cascarilla.js, who value good vibes, aché, and coding awesomeness 😎💅. |
| 21 | + |
| 22 | +So, what are you waiting for? Import Cascarilla.js today and start building amazing things with the coolest of the vibes already granted 🌟! |
| 23 | + |
| 24 | +## 📦 Installation |
| 25 | + |
| 26 | +Cascarilla.js is available on npm, so you can install it with one of the following commands: |
| 27 | + |
| 28 | +```bash |
| 29 | +npm install cascarilla |
| 30 | +pnpm install cascarilla |
| 31 | +yarn add cascarilla |
| 32 | +``` |
| 33 | + |
| 34 | +## 📖 Usage |
| 35 | + |
| 36 | +Once you've installed Cascarilla.js, you can import it into your project and start using its features. |
| 37 | + |
| 38 | +```javascript |
| 39 | +import { siacaraa } from "cascarilla"; |
| 40 | + |
| 41 | +siacaraa(); |
5 | 42 | ``` |
6 | 43 |
|
7 | | -[](https://stackblitz.com/github/withastro/astro/tree/latest/examples/basics) |
8 | | -[](https://codesandbox.io/p/sandbox/github/withastro/astro/tree/latest/examples/basics) |
9 | | -[](https://codespaces.new/withastro/astro?devcontainer_path=.devcontainer/basics/devcontainer.json) |
| 44 | +That's it! Feel the good vibes and forget about the bugs and linting frustrations. 🌿🌿 |
| 45 | + |
| 46 | +## 📝 License |
| 47 | + |
| 48 | +Cascarilla.js is licensed under the MIT License. |
| 49 | + |
10 | 50 |
|
11 | | -> 🧑🚀 **Seasoned astronaut?** Delete this file. Have fun! |
| 51 | +## Contributions |
12 | 52 |
|
13 | | - |
| 53 | +Contributions are always welcome! If you'd like to contribute to Cascarilla.js, please feel free to submit a pull request or open an issue on the GitHub repository. |
14 | 54 |
|
15 | | -## 🚀 Project Structure |
| 55 | +## Build |
16 | 56 |
|
17 | | -Inside of your Astro project, you'll see the following folders and files: |
| 57 | +To build Cascarilla.js, you can use the following commands: |
18 | 58 |
|
19 | | -```text |
20 | | -/ |
21 | | -├── public/ |
22 | | -│ └── favicon.svg |
23 | | -├── src/ |
24 | | -│ ├── layouts/ |
25 | | -│ │ └── Layout.astro |
26 | | -│ └── pages/ |
27 | | -│ └── index.astro |
28 | | -└── package.json |
| 59 | +```bash |
| 60 | +pnpm run build |
29 | 61 | ``` |
30 | 62 |
|
31 | | -To learn more about the folder structure of an Astro project, refer to [our guide on project structure](https://docs.astro.build/en/basics/project-structure/). |
| 63 | +This will generate a new build of Cascarilla.js in the `dist` directory. |
32 | 64 |
|
33 | | -## 🧞 Commands |
| 65 | +## Authors |
34 | 66 |
|
35 | | -All commands are run from the root of the project, from a terminal: |
| 67 | +Cascarilla.js was an original idea from Alejandro Rivera and the CuCoders Community members. |
36 | 68 |
|
37 | | -| Command | Action | |
38 | | -| :------------------------ | :----------------------------------------------- | |
39 | | -| `npm install` | Installs dependencies | |
40 | | -| `npm run dev` | Starts local dev server at `localhost:4321` | |
41 | | -| `npm run build` | Build your production site to `./dist/` | |
42 | | -| `npm run preview` | Preview your build locally, before deploying | |
43 | | -| `npm run astro ...` | Run CLI commands like `astro add`, `astro check` | |
44 | | -| `npm run astro -- --help` | Get help using the Astro CLI | |
| 69 | +## Constributors |
45 | 70 |
|
46 | | -## 👀 Want to learn more? |
| 71 | +<a href="https://github.com/CuCodersCommunity/cascarilla.js/graphs/contributors"> |
| 72 | + <img src="https://contrib.rocks/image?repo=CuCodersCommunity/cascarilla.js" /> |
| 73 | +</a> |
47 | 74 |
|
48 | | -Feel free to check [our documentation](https://docs.astro.build) or jump into our [Discord server](https://astro.build/chat). |
| 75 | +Made with [contrib.rocks](https://contrib.rocks). |
0 commit comments