mirror of
https://github.com/IT4Change/ohmyform-ui.git
synced 2025-12-13 01:35:51 +00:00
update readme
This commit is contained in:
parent
5cc1565751
commit
494bb41af4
4
.dockerignore
Normal file
4
.dockerignore
Normal file
@ -0,0 +1,4 @@
|
||||
/out
|
||||
/node_modules
|
||||
/.git
|
||||
/.next
|
||||
7
Dockerfile
Normal file
7
Dockerfile
Normal file
@ -0,0 +1,7 @@
|
||||
FROM node:12-alpine
|
||||
|
||||
WORKDIR /usr/src/app
|
||||
|
||||
COPY . ./
|
||||
|
||||
CMD [ "yarn", "start" ]
|
||||
32
README.md
32
README.md
@ -1,30 +1,6 @@
|
||||
This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/zeit/next.js/tree/canary/packages/create-next-app).
|
||||
# OhMyForm UI
|
||||
|
||||
## Getting Started
|
||||
[](https://opencollective.com/ohmyform-sustainability) ![Project Status]
|
||||
|
||||
First, run the development server:
|
||||
|
||||
```bash
|
||||
npm run dev
|
||||
# or
|
||||
yarn dev
|
||||
```
|
||||
|
||||
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
|
||||
|
||||
You can start editing the page by modifying `pages/index.tsx`. The page auto-updates as you edit the file.
|
||||
|
||||
## Learn More
|
||||
|
||||
To learn more about Next.js, take a look at the following resources:
|
||||
|
||||
- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
|
||||
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
|
||||
|
||||
You can check out [the Next.js GitHub repository](https://github.com/zeit/next.js/) - your feedback and contributions are welcome!
|
||||
|
||||
## Deploy on Vercel
|
||||
|
||||
The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/import?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
|
||||
|
||||
Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.
|
||||
[](https://discord.gg/MJqAuAZ)
|
||||
> An *open source alternative to TypeForm* that can create stunning mobile-ready forms, surveys and questionnaires.
|
||||
|
||||
46
doc/development.md
Normal file
46
doc/development.md
Normal file
@ -0,0 +1,46 @@
|
||||
# Development
|
||||
|
||||
tip's and tricks to get you started
|
||||
|
||||
## First Run
|
||||
|
||||
install yarn on your system if not already present and then install all dependencies
|
||||
by running `yarn install`
|
||||
|
||||
## Development Run
|
||||
|
||||
to run with hot code reloading call `yarn start:dev`
|
||||
|
||||
## Production Run
|
||||
|
||||
there are 2 options for a production build, one with SSR enabled and one for static exports.
|
||||
|
||||
### Static Export
|
||||
|
||||
To create a static export call `yarn export`, this will create the folder `/out` that can
|
||||
be copied to any static hosting site.
|
||||
|
||||
### SSR
|
||||
|
||||
first build the current codebase by `yarn build` and then execute `yarn start`, any request
|
||||
coming into the system will then be rendered on the server. (great for SEO)
|
||||
|
||||
## Configuration Options
|
||||
|
||||
### GraphQL Path
|
||||
|
||||
Per default the graphql endpoint is expected at `/graphql` on the same host as the frontend.
|
||||
To modify this pass the environment variable API_HOST with the parameter you need.
|
||||
|
||||
With a local backend you could start ie the dev server with
|
||||
`API_HOST=http://localhost:4100/graphql yarn start:dev`
|
||||
|
||||
|
||||
## Used Tools / Libraries
|
||||
|
||||
- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
|
||||
- [Ant Design](https://ant.design/components) - UI Framework used
|
||||
- [SwiperJS](https://swiperjs.com/) - Form Slides
|
||||
- [Apollo Client](https://www.apollographql.com/docs/react/) - GraphQL Client
|
||||
- [Styled Components](https://styled-components.com/) - Component Styling
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user