Most builds on Cyclic are as easy as hitting that bright green “Deploy” button and waiting for your confetti. However some take a little more setup.
It’s still easy, it’s still fun, it just takes a little more “know how.”
So let’s look at one of our most powerful tools to get things done and maximize your deploying power on Cyclic: Build Options.
Over my next couple posts, I’m going to go through some of the most popular ways to use Build Options and we’ll have a little fun.
There are two places to find Build Options in Cyclic, which really have to do with when you’ll need them.
Alright, now you know where to find them, so what do you do with them? Let's start with one simple way to use Build Options. In this post, we’re going to start nice and easy and deploy a static site.
If you aren’t familiar with the term “static site,” you may think of them as client-side only websites. A classic example would be a resume site or a portfolio site. In this case you only need to serve a frontend. There’s no database, no GET, no POST, no CRUD. You get the picture.
However, because of how Cyclic reads your repo to make sure it’s ready to go, currently you’ll still need to add a package.json file for Cyclic to deploy it. That means we still need Node.js baybeeee!
Now, that we have chosen a project to host, let's get our Node on.
If we have Node installed already, this is a piece of cake. If not, I recommend heading to the Node.js website and starting with Node’s recommendation for how to install it on your operating system https://nodejs.org/.
Once Node.js is on board, we can move on to the next step.
npm init in the root directory of the project (in the terminal).
Node will run us through a brief setup of our package.json file. In most cases, we just have to hit enter until the file is added to our project root folder. You can always customize your package.json, but for a static site, it doesn’t really matter.
The final piece of setup is to add the start script
”start”: node index.js to scripts in our brand new package.json file. Cyclic specifically looks for the node start script to give us access to the screen with the ✨Advanced Build Options✨.
Yes, we know, we don’t specifically have an “index.js” file in this application. It’s ok. Just go with it.
Now we're going to push our brand new package.json file up to Github and get ready to deploy on Cyclic.
As soon as we get to the Connect screen we are going to hit “Advanced” and toggle “Static site” to the “on” position.
We'll hit the Connect button now and BINGO! That calculatin' static site is 🎉live🎉 and hosted on Cyclic.
And just to hammer it home, if we head over to the dashboard, we can see the Static Site toggle is turned on there as well, nice:
So there it is, the simplest use for Advanced Build Options and the first step on our journey towards understanding how to use all the bells and whistles Cyclic has to offer.
I'll have more on Build Options soon, but if you have questions in the meantime, come chat with us in Discord: discord.cyclic.sh.
Want to see the cheat codes on my Sneaky Calc, click here.
Enter your email If you would like to get an email the next time we post.
We post about ~1-2x per month, and up to once a month about company news.
Fork and deploy a hello world project onto Cyclic faster than it has taken to read this page. Experience the power.Deploy on Cyclic 🚀