Skip to content

Latest commit

 

History

History
177 lines (121 loc) · 4.37 KB

README.md

File metadata and controls

177 lines (121 loc) · 4.37 KB

Resource Gallery provides the tools and resources you need to evolve into a skilled developer.

You can grab a cool Astro badge after successful merged PR from here

Deployed on Cloudflare pages

image

Pagespeed Score

pagespeed

Installation

You can clone the project directly from this repo to your local system.

1. Clone the repo

git clone https://github.com/ZeroOctave/resource-gallery.git .

The . will clone it to the current directory so make sure you are inside your project folder first.

2. Install Dependencies

npm install
# or
yarn install
# or (recommended)
pnpm install

3. Start development Server

npm run dev
# or
yarn dev
# or (recommended)
pnpm dev

Preview & Build

npm run preview
npm run build
# or
yarn preview
yarn build
# or (recommended)
pnpm preview
pnpm build

We recommend using pnpm to save disk space on your computer.

Other Commands

pnpm astro ...
pnpm astro add
pnpm astro --help

5 Create a new branch:

git checkout -b YourBranchName

6. Sync your fork or your local repository with the origin repository:

  • In your forked repository, click on "Fetch upstream"
  • Click "Fetch and merge"

Alternatively, Git CLI way to Sync forked repository with origin repository:

git fetch upstream
git merge upstream/main

Github Docs for Syncing

7. Make your changes to the source code.

8. Stage your changes:

⚠️ Make sure not to commit package.json or package-lock.json file

⚠️ Make sure not to run the commands git add . or git add *

Instead, stage your changes for each file/folder

By using public path it means it will add all files and folders under that folder, it is better to be specific

git add public

or

git add "<files_you_have_changed>"

9. Commit your changes:

git commit -m "<your_commit_message>"

10. Push your local commits to the remote repository:

git push origin YourBranchName

11. Create a Pull Request!

Project Structure

Inside of your Astro project, you'll see the following folders and files:

/
├── public/
│   └── ...
├── src/
│   ├── components/
│   │   └── ...
│   ├── layouts/
│   │   └── ...
│   └── pages/
│       └── ...
└── package.json

Astro looks for .astro or .md files in the src/pages/ directory. Each page is exposed as a route based on its file name.

Any static assets, like images, can be placed in the public/ directory.

TailwindCSS

TailwindCSS is already configured in this repo, so you can start using it without any installation.

Credits

Astroship by Web3Templates

👀 Want to learn more?

Feel free to check out Astro Docs

Built with Astro