-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
3e47b5d
commit 03360cb
Showing
3 changed files
with
93 additions
and
37 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
# How to contribute | ||
|
||
## Types of contributions | ||
|
||
Contributions of all types are welcome, including: | ||
|
||
- Code | ||
- Testing | ||
- Translations | ||
- Bug reports | ||
- Suggestions | ||
|
||
## To-do's | ||
|
||
- [ ] Creating the GUI using Tailwind for the styles | ||
- [ ] Add testing | ||
- [ ] Add download logic | ||
- [ ] Add Spanish translation | ||
- [ ] Adding logic to allow the user to change the language | ||
|
||
## How to submit a contribution | ||
|
||
To submit a contribution, follow these steps: | ||
|
||
1. Create a fork of the project on GitHub. | ||
2. Create a development branch for your contribution. | ||
3. Make your changes to the development branch. | ||
4. Test your changes. | ||
5. Submit a pull request to the main project branch. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
# CC BY-NC-SA 4.0 | ||
|
||
## GetsMyApps by Raul Catalinas Esteban is licensed under CC BY-NC-SA 4.0 | ||
|
||
### Attribution-NonCommercial-ShareAlike 4.0 International | ||
|
||
This license requires that reusers give credit to the creator. It allows reusers to distribute, remix, adapt, and build upon the material in any medium or format, for noncommercial purposes only. If others modify or adapt the material, they must license the modified material under identical terms. | ||
|
||
BY: Credit must be given to you, the creator. | ||
|
||
NC: Only noncommercial use of your work is permitted. | ||
Noncommercial means not primarily intended for or directed towards commercial advantage or monetary compensation. | ||
|
||
SA: Adaptations must be shared under the same terms. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,54 +1,67 @@ | ||
# Astro Starter Kit: Basics | ||
# GetsMyApps | ||
|
||
```sh | ||
npm create astro@latest -- --template basics | ||
Website to make it easy for users to download my apps | ||
|
||
The apps are displayed as a card and each app has 2 buttons, one to view the source code on GitHub and one to download the app. | ||
|
||
In each app a logo of the OS for which the app is available is shown. | ||
|
||
## Run Locally | ||
|
||
Clone the project | ||
|
||
```bash | ||
git clone https://github.com/RaulCatalinas/GetsMyApps.git | ||
#or | ||
git clone [email protected]:RaulCatalinas/GetsMyApps.git | ||
#or | ||
gh repo clone RaulCatalinas/GetsMyApps | ||
``` | ||
|
||
[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/withastro/astro/tree/latest/examples/basics) | ||
[![Open with CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/sandbox/github/withastro/astro/tree/latest/examples/basics) | ||
[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/withastro/astro?devcontainer_path=.devcontainer/basics/devcontainer.json) | ||
Go to the project directory | ||
|
||
> 🧑🚀 **Seasoned astronaut?** Delete this file. Have fun! | ||
```bash | ||
cd GetsMyApps | ||
``` | ||
|
||
![just-the-basics](https://github.com/withastro/astro/assets/2244813/a0a5533c-a856-4198-8470-2d67b1d7c554) | ||
Install dependencies | ||
|
||
## 🚀 Project Structure | ||
```bash | ||
npm install | ||
#or | ||
yarn install | ||
#or | ||
pnpm install | ||
#or | ||
bun install | ||
``` | ||
|
||
Inside of your Astro project, you'll see the following folders and files: | ||
Start the server | ||
|
||
```text | ||
/ | ||
├── public/ | ||
│ └── favicon.svg | ||
├── src/ | ||
│ ├── components/ | ||
│ │ └── Card.astro | ||
│ ├── layouts/ | ||
│ │ └── Layout.astro | ||
│ └── pages/ | ||
│ └── index.astro | ||
└── package.json | ||
```bash | ||
npm run dev | ||
#or | ||
yarn run dev | ||
#or | ||
pnpm run dev | ||
#or | ||
bun run dev | ||
``` | ||
|
||
Astro looks for `.astro` or `.md` files in the `src/pages/` directory. Each page is exposed as a route based on its file name. | ||
## Contributing | ||
|
||
Contributions are always welcome! | ||
|
||
There's nothing special about `src/components/`, but that's where we like to put any Astro/React/Vue/Svelte/Preact components. | ||
See [CONTRIBUTING.md](CONTRIBUTING.md) for ways to get started. | ||
|
||
Any static assets, like images, can be placed in the `public/` directory. | ||
## Feedback | ||
|
||
## 🧞 Commands | ||
If you have any feedback, please reach out to us at <[email protected]> | ||
|
||
All commands are run from the root of the project, from a terminal: | ||
## License | ||
|
||
| Command | Action | | ||
| :------------------------ | :----------------------------------------------- | | ||
| `npm install` | Installs dependencies | | ||
| `npm run dev` | Starts local dev server at `localhost:4321` | | ||
| `npm run build` | Build your production site to `./dist/` | | ||
| `npm run preview` | Preview your build locally, before deploying | | ||
| `npm run astro ...` | Run CLI commands like `astro add`, `astro check` | | ||
| `npm run astro -- --help` | Get help using the Astro CLI | | ||
The license information is contained in the file [LICENSE.md](LICENSE.md). | ||
|
||
## 👀 Want to learn more? | ||
## Authors | ||
|
||
Feel free to check [our documentation](https://docs.astro.build) or jump into our [Discord server](https://astro.build/chat). | ||
- [Raul Catalinas Esteban](https://github.com/RaulCatalinas) |