Frontend developer and Javascript engineer
To get started, just clone the repository and run npm install && npm run dev:
git clone https://github.com/iaincollins/nextjs-starter.git
npm install
npm run dev
Note: If you are running on Windows run install --noptional flag (i.e.
npm install --no-optional) which will skip installing fsevents.
If you wanted to run this site in production, you should install modules then
build the site with npm run build and run it with npm start:
npm install
npm run build
npm start
You should run npm run build again any time you make changes to the site.
Note: If you are already running a webserver on port 80 (e.g. Macs usually have
the Apache webserver running on port 80) you can still start the example in
production mode by passing a different port as an Environment Variable when
starting (e.g. PORT=3000 npm start).
If you configure a .env file (just copy .env.example over to '.env' and fill in the options) you can configure a range of options.
See the AUTHENTICATION.md for how to set up oAuth if you want to do that. It suggested you start with Twitter as it's the easiest to get working.
To deploy to production on Zeit's now.sh cloud platform you
will need to install the Now desktop app on your computer. If you don't want
to install the Now desktop app, you can use the following command to install
it (either approach is fine):
sudo npm i -g --unsafe-perm now
Once installed, open now.json and set a name and alias for your site.
To deploy, just run now in the working directory:
npm install -g now
now
If you configure a .env file now will include it when deploying if you use the
-E option to deploy:
now -E
If you want to have your local .env file have variables for local development
and have a different sent of variables you use in production, you can create
additional .env files and tell now to use a specific file when deploying:
now -E production.env
Once you have deployed, now will return a URL where the site when it has been
deployed to, you can use this to preview everything works correctly in the
browser.
If you have set an alias for the site, you can then make the site live on the
alias you have defined using now alias:
now alias
By default, this will point any aliases you have set in now.json to your site.
You can configure now to use aliases with custom domains using the
now domain and now dns commands.
If you need an instance of MongoDB in the cloud https://mlab.com/ have free and inexpensive options.
Once you are comfortable using .env files for configuration and running and
deploying your app, take a look at now secrets to set options in the cloud so
you don't have to set them each time you deploy.
You can integrate now with a GitHub account to trigger automated deployments
anytime you push to GitHub. This works great if you have secrets set up!
When you deploy this project you will see this message as of November 2018:
WARN! You are using an old version of the Now Platform. More: https://zeit.co/docs/v1-upgrade
Now 2.0 was released in November 2018 and works differently from Now 1.0. This project has not been updated for Now 2.0. You may ignore this message for now.
You can host your Next.js site with any hosting provider. Although it works great on Now, it also works great with other providers like Heroku, Amazon Web Service, Google Cloud Platform, Microsoft Azure, DigitalOcean and others.