148 lines
4.1 KiB
Markdown
148 lines
4.1 KiB
Markdown
# 🚀 OW Digital FreeZone
|
|
|
|
<img src="https://raw.githubusercontent.com/onwidget/.github/main/src/assets/logo.png" align="right"
|
|
alt="" width="100" height="358">
|
|
|
|
|
|
**OW Digital FreeZone** is a collaboration between the Government of Zanzibar and OurWorld Venture Creator. We are the world's first 100% digital free zone, accessible and affordable for all. Removing complexity from doing business.
|
|
|
|
|
|
## LIVE
|
|
|
|
📌 [https://freezone.ourworld.tf/](https://freezone.ourworld.tf/)
|
|
|
|
|
|
### Getting Started
|
|
|
|
All commands are run from the root of the project, from a terminal:
|
|
|
|
| Command | Action |
|
|
| :-------------------- | :------------------------------------------------- |
|
|
| `npm install` | Installs dependencies |
|
|
| `npm run dev` | Starts local dev server at `localhost:3000` |
|
|
| `npm run build` | Build your production site to `./dist/` |
|
|
| `npm run preview` | Preview your build locally, before deploying |
|
|
| `npm run format` | Format codes with Prettier |
|
|
| `npm run lint:eslint` | Run Eslint |
|
|
| `npm run astro ...` | Run CLI commands like `astro add`, `astro preview` |
|
|
|
|
<br>
|
|
|
|
### Configuration
|
|
|
|
Basic configuration file: `./src/config.yaml`
|
|
|
|
```yaml
|
|
site:
|
|
name: 'Example'
|
|
site: 'https://example.com'
|
|
base: '/' # Change this if you need to deploy to Github Pages, for example
|
|
trailingSlash: false # Generate permalinks with or without "/" at the end
|
|
|
|
googleSiteVerificationId: false # Or some value,
|
|
|
|
# Default SEO metadata
|
|
metadata:
|
|
title:
|
|
default: 'Example'
|
|
template: '%s — Example'
|
|
description: 'This is the default meta description of Example website'
|
|
robots:
|
|
index: true
|
|
follow: true
|
|
openGraph:
|
|
site_name: 'Example'
|
|
images:
|
|
- url: '~/assets/images/default.png'
|
|
width: 1200
|
|
height: 628
|
|
type: website
|
|
twitter:
|
|
handle: '@twitter_user'
|
|
site: '@twitter_user'
|
|
cardType: summary_large_image
|
|
|
|
i18n:
|
|
language: en
|
|
textDirection: ltr
|
|
|
|
apps:
|
|
blog:
|
|
isEnabled: true # If the blog will be enabled
|
|
postsPerPage: 6 # Number of posts per page
|
|
|
|
post:
|
|
isEnabled: true
|
|
permalink: '/blog/%slug%' # Variables: %slug%, %year%, %month%, %day%, %hour%, %minute%, %second%, %category%
|
|
robots:
|
|
index: true
|
|
|
|
list:
|
|
isEnabled: true
|
|
pathname: 'blog' # Blog main path, you can change this to "articles" (/articles)
|
|
robots:
|
|
index: true
|
|
|
|
category:
|
|
isEnabled: true
|
|
pathname: 'category' # Category main path /category/some-category, you can change this to "group" (/group/some-category)
|
|
robots:
|
|
index: true
|
|
|
|
tag:
|
|
isEnabled: true
|
|
pathname: 'tag' # Tag main path /tag/some-tag, you can change this to "topics" (/topics/some-category)
|
|
robots:
|
|
index: false
|
|
|
|
isRelatedPostsEnabled: true # If a widget with related posts is to be displayed below each post
|
|
relatedPostsCount: 4 # Number of related posts to display
|
|
|
|
analytics:
|
|
vendors:
|
|
googleAnalytics:
|
|
id: null # or "G-XXXXXXXXXX"
|
|
|
|
ui:
|
|
theme: 'system' # Values: "system" | "light" | "dark" | "light:only" | "dark:only"
|
|
```
|
|
|
|
<br>
|
|
|
|
#### Customize Design
|
|
|
|
To customize Font families, Colors or more Elements refer to the following files:
|
|
|
|
- `src/components/CustomStyles.astro`
|
|
- `src/assets/styles/tailwind.css`
|
|
|
|
### Preview
|
|
|
|
You can create a local preview on your web browser with:
|
|
|
|
```shell
|
|
npm run dev
|
|
```
|
|
|
|
#### Deploy to production (manual)
|
|
|
|
You can create an optimized production build with:
|
|
|
|
```shell
|
|
npm run build
|
|
```
|
|
|
|
Now, your website is ready to be deployed. All generated files are located at
|
|
`dist` folder, which you can deploy the folder to any hosting service you
|
|
prefer.
|
|
|
|
|
|
## Contributing
|
|
|
|
If you have any ideas, suggestions or find any bugs, feel free to open a discussion, an issue or create a pull request.
|
|
That would be very useful for all of us and we would be happy to listen and take action.
|
|
|
|
## License
|
|
|
|
**AstroWind Template** is licensed under the MIT license — see the [LICENSE](./LICENSE.md) file for details.
|