Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/terieyenike/portfolio
A place to find out about me - personal page built with Astro
https://github.com/terieyenike/portfolio
astro javascript markdown
Last synced: about 5 hours ago
JSON representation
A place to find out about me - personal page built with Astro
- Host: GitHub
- URL: https://github.com/terieyenike/portfolio
- Owner: Terieyenike
- License: mit
- Created: 2023-02-13T20:08:48.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-09-11T21:32:24.000Z (2 months ago)
- Last Synced: 2024-09-12T07:56:27.620Z (2 months ago)
- Topics: astro, javascript, markdown
- Language: Astro
- Homepage: https://www.iamteri.tech/
- Size: 1.76 MB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Stone: Astro Theme
Stone is a free and open-source Astro theme specially designed for Business, Marketing, SaaS and Startup websites.
## Key Features:
- **Built with Tailwind CSS & Alpine.js**
- **5+ Pages**
- **15+ Sections**
- Clean & Modern Design
- Fully Responsive
- Dark & Light Mode
- Fast & Performant
- Super Lightweight
- View Transitions (experimental)
- **Prettier** Code Formatter
- **Google Fonts**
- **Remix Icons**
- Free Updates
## Getting Started
### Requirements
- Basic knowledge of Astro, HTML and CSS.
- Text editor (We recommend Visual Studio Code)
- Node.js 18 or higher.
### Install dependencies
Navigate to your project folder and install its dependencies:
```
npm install
```
### Start
Once the installation is done, you can now run your app:
```
npm run dev
```
This runs the app in development mode. Open http://localhost:3000 to view it in the browser.
### Build
```
npm run build
```
This builds the app for production to the `./dist/` folder.
## Project Structure
Inside the project, you'll see the following folders and files:
```
/
├── public/
├── src/
│ ├── components/
│ ├── layouts/
│ └── pages/
├── .prettierrc
├── astro.config.mjs
├── package-lock.json
├── package.json
├── README.md
├── tailwind.config.cjs
└── tsconfig.json
```
- `public/*` - Any static assets (images, fonts, icons, ...)
- `src/*` - Project source code (components, pages, ...)
- `src/components/*` - Reusable Astro components used to build pages.
- `src/layouts/*` - Astro components that define the UI structure shared by one or more pages..
- `src/pages/*` - Astro components used to create new pages on your site. Each page is exposed as a route based on its file name.
- `.prettierrc` - Prettier configuration file.
- `astro.config.mjs` - Astro configuration file.
- `package.json` - File used by JavaScript package managers to manage your dependencies. It also defines the scripts that are commonly used to run Astro.
- `tailwind.config.cjs` - Tailwind configuration file. The theme section is where you define your color palette and fonts.
- `tsconfig.json` - TypeScript configuration file.
## Deployment
Ready to build and deploy your site? Follow the [official documentation](https://docs.astro.build/en/guides/deploy/).
## Support
If you have any questions or suggestions do not hesitate to contact me.
## License
This project is licensed under the terms of the MIT license.