Как да разположите приложението си в мрежата с помощта на Express.js и Heroku

Ако сте нов в света на уеб разработката, ще отделите много време, за да научите как да създавате статични сайтове с HTML, CSS и JavaScript.

След това може да започнете да научавате как да използвате популярни рамки като React, VueJS или Angular.

Но след като изпробвате няколко нови идеи и стартирате някои сайтове локално, може да се чудите как всъщност да разположите вашия сайт или приложение. И както се оказва, понякога може да е трудно да се знае откъде да се започне.

Лично аз намирам, че експресният сървър, хостван на Heroku, е един от най-простите начини за придвижване. Тази статия ще ви покаже как да направите това.

Heroku е облачна платформа, която поддържа редица различни програмни езици и рамки.

Това не е спонсориран пост - разбира се, има много други решения, като например:

  • Цифров океан
  • Amazon Web Services
  • Лазурен
  • Google Cloud Platform
  • Netlify
  • ZEIT сега

Проверете ги всички и вижте кое отговаря най-добре на вашите нужди.

Лично аз открих, че Heroku е най-бързият и най-лесният за започване на използване „от кутията“. Безплатното ниво е малко ограничено по отношение на ресурсите. Мога обаче да го препоръчам с увереност за целите на тестването.

Този пример ще хоства прост сайт, използващ Express сървър. Ето стъпките на високо ниво:

  1. Настройка с Heroku, Git, npm
  2. Създайте Express.js сървър
  3. Създавайте статични файлове
  4. Внедряване в Heroku

Общо трябва да отнеме около 25 минути (или повече, ако искате да отделите повече време за статичните файлове).

Тази статия предполага, че вече знаете:

  • Някои основи на HTML, CSS и JavaScript
  • Основно използване на командния ред
  • Git за начинаещи за контрол на версиите

Можете да намерите целия код в това хранилище.

Настройвам

Първата стъпка във всеки проект е да настроите всички инструменти, за които знаете, че ще ви трябват.

Ще трябва да имате:

  • Възел и npm, инсталирани на вашата локална машина (прочетете как да направите това тук)
  • Git е инсталиран (прочетете това ръководство)
  • Инсталиран CLI Heroku (ето как да го направите)

1. Създайте нова директория и инициализирайте Git хранилище

От командния ред създайте нова директория на проекта и преминете в нея.

$ mkdir lorem-ipsum-demo $ cd lorem-ipsum-demo

Сега сте в папката на проекта, инициализирайте ново хранилище на Git.

⚠️ Тази стъпка е важна, защото Heroku разчита на Git за разполагане на код от вашата локална машина към нейните облачни сървъри ⚠️

$ git init

Като последна стъпка можете да създадете файл README.md, който да редактирате на по-късен етап.

$ echo "Edit me later" > README.md

2. Влезте в Heroku CLI и създайте нов проект

Можете да влезете в Heroku, използвайки Heroku CLI (интерфейс на командния ред). За да направите това, ще трябва да имате безплатен акаунт в Heroku.

Тук има две възможности. По подразбиране Heroku ви позволява да влизате през уеб браузъра. Добавянето на -iфлага ви позволява да влезете през командния ред.

$ heroku login -i

Сега можете да създадете нов проект Heroku. Обадих се на моята lorem-ipsum-demo.

$ heroku create lorem-ipsum-demo

Именуване на вашия проект:

  • Heroku ще генерира произволно име за вашия проект, ако не посочите такова в командата.
  • Името ще бъде част от URL адреса, който можете да използвате за достъп до вашия проект, така че изберете такъв, който ви харесва.
  • Това също означава, че трябва да изберете уникално име на проект, което никой друг не е използвал.
  • Възможно е да преименувате проекта си по-късно (така че не се притеснявайте много за получаването на идеалното име точно сега).

3. Инициализирайте нов npm проект и инсталирайте Express.js

След това можете да инициализирате нов npm проект, като създадете файл package.json. Използвайте командата по-долу, за да направите това.

⚠️ Тази стъпка е от решаващо значение. Heroku разчита на това, че предоставяте файл package.json, за да знае, че това е проект на Node.js, когато изгражда вашето приложение ⚠️

$ npm init -y

След това инсталирайте Express. Express е широко използвана сървърна рамка за NodeJS.

$ npm install express --save

И накрая, готови сте да започнете да кодирате!

Писане на прост Express сървър

Следващата стъпка е да създадете файл, наречен app.js, който изпълнява Express сървър локално.

$ touch app.js

Този файл ще бъде входната точка на приложението, когато е готово. Това означава, че едната команда, необходима за стартиране на приложението, ще бъде:

$ node app.js

Но първо трябва да напишете някакъв код във файла.

4. Редактирайте съдържанието на app.js

Отворете app.jsв любимия си редактор. Напишете кода, показан по-долу, и щракнете върху запазване.

// create an express app const express = require("express") const app = express() // use the express-static middleware app.use(express.static("public")) // define the first route app.get("/", function (req, res) { res.send("

Hello World!

") }) // start the server listening for requests app.listen(process.env.PORT || 3000, () => console.log("Server is running..."));

Коментарите трябва да помогнат да се посочи какво се случва. Но нека бързо разбием кода, за да го разберем по-нататък:

  • The first two lines simply require the Express module and create an instance of an Express app.
  • The next line requires the use of the express.static middleware. This lets you serve static files (such as HTML, CSS and JavaScript) from the directory you specify. In this case, the files will be served from a folder called public.
  • The next line uses app.get() to define a URL route. Any URL requests to the root URL will be responded to with a simple HTML message.
  • The final part starts the server. It either looks to see which port Heroku will use, or defaults to 3000 if you are running locally.

⚠️The use of process.env.PORT || 3000 in the last line is important for deploying your app successfully ⚠️

If you save app.js and start the server with:

$ node app.js

You can visit localhost:3000 in your browser and see for yourself the server is running.

Create your static files

The next step is to create your static files. These are the HTML, CSS and JavaScript files you will serve up whenever a user visits your project.

Remember in app.js you told the express.static middleware to serve static files from the public directory.

The first step is of course to create such a directory and the files it will contain.

$ mkdir public $ cd public $ touch index.html styles.css script.js

5. Edit the HTML file

Open index.html in your preferred text editor. This will be the basic structure of the page you will serve to your visitors.

The example below creates a simple landing page for a Lorem Ipsum generator, but you can be as creative as you like here.

Lorem Ipsum generator

How many paragraphs do you want to generate?

Generate Copy!

6. Edit the CSS file

Next up is editing the CSS file styles.css. Make sure this is linked in your HTML file.

The CSS below is for the Lorem Ipsum example. But again, feel free to be as creative as you want.

h1 { font-family: 'Alegreya' ; } body { font-family: 'Source Sans Pro' ; width: 50%; margin-left: 25%; text-align: justify; line-height: 1.7; font-size: 18px; } input { font-size: 18px; text-align: center; } button { font-size: 18px; color: #fff; } #generate { background-color: #09f; } #copy { background-color: #0c6; }

7. Edit the JavaScript file

Finally, you might want to edit the JavaScript file script.js. This will let you make your page more interactive.

The code below defines two basic functions for the Lorem Ipsum generator. Yes, I used JQuery - it's quick and easy to work with.

$("#generate").click(function(){ var lorem = $("#lorem"); lorem.html(""); var quantity = $("#quantity")[0].valueAsNumber; var data = ["Lorem ipsum", "quia dolor sit", "amet", "consectetur"]; for(var i = 0; i < quantity; i++){ lorem.append("

"+data[i]+"

"); } }) $("#copy").click(function() { var range = document.createRange(); range.selectNode($("#lorem")[0]); window.getSelection().removeAllRanges(); window.getSelection().addRange(range); document.execCommand("copy"); window.getSelection().removeAllRanges(); } )

Note that here, the data list is truncated to make it easier to show. In the actual app, it is a much longer list of full paragraphs. You can see the entire file in the repo, or look here for the original source.

Deploying your app

After writing your static code and checking it all works as expected, you can get ready to deploy to Heroku.

However, there are a couple more things to do.

8. Create a Procfile

Heroku will need a Procfile to know how to run your app.

A Procfile is a "process file" which tells Heroku which command to run in order to manage a given process. In this case, the command will tell Heroku how to start your server listening on the web.

Use the command below to create the file.

⚠️This is an important step, because without a Procfile, Heroku cannot put your server online. ⚠️

$ echo "web: node app.js" > Procfile

Notice that the Procfile has no file extension (e.g., ".txt", ".json").

Also, see how the command node app.js is the same one used locally to run your server.

9. Add and commit files to Git

Remember you initiated a Git repository when setting up. Perhaps you have been adding and committing files as you have gone.

Before you deploy to Heroku, make sure to add all the relevant files and commit them.

$ git add . $ git commit -m "ready to deploy"

The final step is to push to your Heroku master branch.

$ git push heroku master

You should see the command line print out a load of information as Heroku builds and deploys your app.

The line to look for is: Verifying deploy... done.

This shows that your build was successful.

Now you can open the browser and visit your-project-name.herokuapp.com. Your app will be hosted on the web for all to visit!

Quick recap

Below are the steps to follow to deploy a simple Express app to Heroku:

  1. Create a new directory and initialise a Git repository
  2. Login to the Heroku CLI and create a new project
  3. Initialise a new npm project and install Express.js
  4. Edit the contents of app.js
  5. Edit the static HTML, CSS and JavaScript files
  6. Create a Procfile
  7. Add and commit to Git, then push to your Heroku master branch

Things to check if your app is not working

Sometimes, despite best intentions, tutorials on the Internet don't work exactly as you expected.

The steps below should help debug some common errors you might encounter:

  • Did you initialise a Git repo in your project folder? Check if you ran git init earlier. Heroku relies on Git to deploy code from your local machine.
  • Did you create a package.json file? Check if you ran npm init -y earlier. Heroku requires a package.json file to recognise this is a Node.js project.
  • Is the server running? Make sure your Procfile uses the correct file name to start the server. Check you have web: node app.js and not web: node index.js.
  • Does Heroku know which port to listen on? Check you used app.listen(process.env.PORT || 3000) in your app.js file.
  • Do your static files have any errors in them? Check them by running locally and seeing if there are any bugs.

Thanks for reading - if you made it this far, you might want to checkout the finished version of the demo project.