Skip to content

Getting Started

CranSurvey v1 is developed based on Nuxt. It can be deployed on a serverless platform and connected to different types of databases.

We provided a demo site for you to try out CranSurvey.

One Click Deploy

This method is good for the serverless platforms that can deploy Nuxt App directly, such as Vercel, Netlify, Cloudflare Pages, etc.

For the database part, you need to set the environment variables in the platform's dashboard. The variables are:

  • db_name: The type of the of the database.
  • db_config: The configuration of the database, in JSON format.

For more details, please see the part of Configure the Database.

Vercel

Deploy with Vercel

Netlify

Deploy with Netlify

Manual Deploy

First, you need to clone the repository:

bash
git clone https://github.com/ocoke/CranSurvey.git
git clone https://github.com/ocoke/CranSurvey.git

Then, install the dependencies:

bash
yarn install
yarn install

Then, you need to set an environment variable for building because different platforms need different formats and types of files.

And we need to change the development preset,

for example, if you want to deploy to Vercel, you need to set the environment variable as:

bash
NITRO_PRESET=vercel yarn build
NITRO_PRESET=vercel yarn build

Then, you can deploy the dist folder to the serverless platform you want by following the documents of Nitro.

Enjoy your brand new CranSurvey site!

Released under the MIT License.
The page was translated by Microsoft Translator and other contributors.