Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/code-star/meetup-template
https://github.com/code-star/meetup-template
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/code-star/meetup-template
- Owner: code-star
- Created: 2022-07-10T09:05:28.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-07-11T08:01:54.000Z (over 2 years ago)
- Last Synced: 2023-02-28T10:15:39.980Z (almost 2 years ago)
- Language: TypeScript
- Size: 360 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Meetup Template
## Technical Manual
1. Fork this repo in repo with the name you want as url prefix. E.g. meetup-template will be become https://code-star.github.io/meetup-template.
2. Enable Pages hosting under Settings > Pages. Set source to gh-pages.
3. Modify text and links in public/locales/nl/common.json
4. Update basePath in next.config.js
5. Test locally (see commands below)
6. On push to Github, build will be done automatically with Github Actions
Not needed?
1. (Not needed?) Add an Access token under Settings > Secrets > Actions
Commands:
- develop: `npm run dev` (open http://localhost:3000/meetup-template)
- build: `npm run build` & `serve out/` (will host on http://localhost:3000, but basePath won't be resolved so assets are not loaded)
# TODO
- Static building with i18n
- Ordina favicon
- Styling
- Is URL shape acceptable?
# REMOVE BELOW
This is a really simple project that shows the usage of Next.js with TypeScript.
## Deploy your own
Deploy the example using [Vercel](https://vercel.com?utm_source=github&utm_medium=readme&utm_campaign=next-example) or preview live with [StackBlitz](https://stackblitz.com/github/vercel/next.js/tree/canary/examples/with-typescript)
[](https://vercel.com/new/git/external?repository-url=https://github.com/vercel/next.js/tree/canary/examples/with-typescript&project-name=with-typescript&repository-name=with-typescript)
## How to use it?
Execute [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app) with [npm](https://docs.npmjs.com/cli/init), [Yarn](https://yarnpkg.com/lang/en/docs/cli/create/), or [pnpm](https://pnpm.io) to bootstrap the example:
```bash
npx create-next-app --example with-typescript with-typescript-app
# or
yarn create next-app --example with-typescript with-typescript-app
# or
pnpm create next-app --example with-typescript with-typescript-app
```
Deploy it to the cloud with [Vercel](https://vercel.com/new?utm_source=github&utm_medium=readme&utm_campaign=next-example) ([Documentation](https://nextjs.org/docs/deployment)).
## Notes
This example shows how to integrate the TypeScript type system into Next.js. Since TypeScript is supported out of the box with Next.js, all we have to do is to install TypeScript.
```
npm install --save-dev typescript
```
To enable TypeScript's features, we install the type declarations for React and Node.
```
npm install --save-dev @types/react @types/react-dom @types/node
```
When we run `next dev` the next time, Next.js will start looking for any `.ts` or `.tsx` files in our project and builds it. It even automatically creates a `tsconfig.json` file for our project with the recommended settings.
Next.js has built-in TypeScript declarations, so we'll get autocompletion for Next.js' modules straight away.
A `type-check` script is also added to `package.json`, which runs TypeScript's `tsc` CLI in `noEmit` mode to run type-checking separately. You can then include this, for example, in your `test` scripts.