hackathon starter
8.0.0
Живая демонстрация : ссылка
Прыгнуть к тому, что нового?
Корлер для веб -приложений node.js.
Если вы посещали какие -либо хакатоны в прошлом, то вы знаете, сколько времени нужно, чтобы начать проект: определить, что создать, выбрать язык программирования, выбрать веб -структуру, выбрать фреймворк CSS. Некоторое время спустя у вас может быть начальный проект на GitHub, и только тогда другие члены команды могут начать вносить свой вклад. Или как насчет того, чтобы сделать что -то столь же простое, как войти с аутентификацией Facebook ? Вы можете провести часы на это, если не знакомы с тем, как работает OAuth 2.0.
Когда я начал этот проект, моя основная была сосредоточена на простоте и простоте использования . Я также старался сделать это как можно более общим и многоразовым , чтобы охватить большинство вариантов использования веб -приложений Hackathon, не будучи слишком специфическим. В худшем случае вы можете использовать это в качестве руководства по обучению для своих проектов, если, например, вас заинтересованы только в подписке с аутентификацией Google и ничего больше.
«Хорошо! Это только чтение уже золото!»
- Адриан Ле Бас
«Потрясающе. Просто круто».
- Стивен Рутер
«Я использую его в течение года и много проектов, это потрясающий шаблон, и проект в хорошем состоянии!»
- Кевин Грейнджер
«Маленький мир с проектом Сахата. Мы использовали его стартер для хакатона для нашего хакатона в прошлые выходные и получили несколько призов. Действительно удобно репо!»
- Интервью с кандидатом на одну из компаний, с которыми я работал для работы.
MongoDB (локальная установка или размещение)
Node.js 18+
Инструменты командной строки
Mac OS X: XCODE (или OS X 10,9+ : xcode-select --install )
Windows: Visual Studio Code + подсистема Windows для Linux - Ubuntu или Visual Studio
Ubuntu / Linux Mint: sudo apt-get install build-essential
Fedora : sudo dnf groupinstall "Development Tools"
OpenSuse: sudo zypper install --type pattern devel_basis
ПРИМЕЧАНИЕ. Если вы новичок в узле или экспресс, вы можете найти Node.js & Express From Scratch Series для изучения оснований Node и Express. В качестве альтернативы, вот еще один отличный учебник для начинающих - начало работы с Node.js, Express, Mongodb.
Шаг 1: Самый простой способ начать - клонировать репозиторий:
# Get the latest snapshot
git clone https://github.com/sahat/hackathon-starter.git myproject
# Change directory
cd myproject
# Install NPM dependencies
npm install
# Then simply start your app
node app.js Примечание: я настоятельно рекомендую установить Nodemon. Он наблюдает за любыми изменениями в вашем приложении Node.js и автоматически перезапускает сервер. После установки вместо node app.js используйте nodemon app.js Это сэкономит вам много времени в долгосрочной перспективе, потому что вам не нужно вручную перезагрузить сервер каждый раз, когда вы вносите небольшое изменение кода. Чтобы установить, запустите sudo npm install -g nodemon .
Шаг 2: Получите ключи API и измените конфигурации, если это необходимо, после завершения шага 1 и локальной установки MongoDB, вы сможете получить доступ к приложению через веб -браузер и использовать учетные записи локальных пользователей. Тем не менее, некоторые функции, такие как интеграции API, могут неправильно функционировать, пока вы не получите определенные ключи от поставщиков услуг. Ключи, предоставленные в проекте, служат заполнителями, и вы можете сохранить их для функций, которые вы в настоящее время не используете. Чтобы включить приобретенные ключи в приложение, у вас есть два варианта:
export , например: export FACEBOOK_SECRET=xxxxxx . Этот метод считается лучшей практикой, поскольку он снижает риск случайного, включающего ваши секреты в хранилище кода..env.example : откройте файл .env.example и обновите ключи заполнителей с помощью недавно приобретенных. Этот метод имеет риск случайной регистрации ваших секретов для кодирования репо.Что получить и настроить:
SMTP
Recaptcha
Оаут для социальных входов (войти в систему с / вход в)
Ключи API для поставщиков услуг в примерах API, если вы планируете их использовать.
Mongodb Atlas
Адрес электронной почты
NGROK и HTTPS Если вы хотите использовать какой -то API, который нуждается в HTTPS для работы (например, Pinterest или Facebook), вам нужно будет загрузить NGROK. Запустите NGROK, установите свой BASE_URL на адрес пересылки (то есть https://3ccb-1234-abcd.ngrok-free.app ) и используйте адрес пересылки для доступа к вашему приложению. Если вы используете прокси, такой как NGROK, вы можете получить ошибку несоответствия CSRF, если попытаетесь получить доступ к приложению по http://localhost:8080 вместо адреса https: //...ngrok-free.app.
После установки или загрузки автономного клиента NGROK вы можете начать NGROK, чтобы перехватить данные, обменяемые на порту 8080 с ./ngrok http 8080 в Linux или ngrok http 8080 в Windows.
Шаг 3: Разработайте свое приложение и настройте опыт
Шаг 4: Необязательно - развернуть на производстве см.
Вам нужно будет получить соответствующие учетные данные (идентификатор клиента, секрет клиента, ключ API или имя пользователя и пароль) для API и Service предоставляет вам необходимость. См. Шаг 2 в разделе «Начало работы» для получения дополнительной информации.
Получить учетные данные SMTP от поставщика для транзакционных электронных писем. Установите переменные среды smtp_user, smtp_password и smtp_host. При выборе хоста SMTP имейте в виду, что приложение настроено для использования безопасных SMTP -передачи над портом 465 из коробки. У вас есть возможность выбрать любого поставщика, который соответствует вашим потребностям или воспользоваться одним из следующих поставщиков, каждый из которых предлагает бесплатный уровень для вашего удобства.
| Поставщик | Бесплатный уровень | Веб -сайт |
|---|---|---|
| Sendgrid | 100 электронных писем/день бесплатно | https://sendgrid.com |
| SMTP2GO | 1000 электронных писем/месяц бесплатно | https://www.smtp2go.com |
| Брево | 300 электронных писем/день бесплатно | https://www.brevo.com |
.env . Эти клавиши будут доступны в соответствии с настройками, клавиши Recaptcha упадут, если они вам понадобятся позже позжеhttp://localhost:8080 и т. Д.)http://localhost:8080/auth/google/callback ).envhttp://localhost:8080/auth/snapchat/callback ).env.env.env.envlocalhost в рамках доменов приложенийhttp://localhost:8080 и т. Д.) Под URL сайтаhttp://localhost:8080/auth/facebook/callback ) под действительным OAuth Redirect uris ПРИМЕЧАНИЕ. После успешного входа с Facebook пользователь будет перенаправлен обратно на домашнюю страницу с добавленным хэшем #_=_ в URL. Это не ошибка. Посмотрите на это обсуждение переполнения стека для способов справиться с этим.
http://localhost:8080 и т. Д.) В качестве URL Home страницы.http://localhost:8080/auth/github/callback ).envhttp://localhost:8080 и т. Д.).http://localhost:8080/auth/twitter/callback ).envhttp://localhost:8080/auth/linkedin/callback )http://localhost:8080 и т. Д.).r_basicprofile.env.env.envhttp://localhost:8080/auth/foursquare/callback ).envhttp://localhost:8080/auth/tumblr/callback ).env.envhttp://localhost:8080/auth/twitch/callback ).env.env.env ..env | Имя | Описание |
|---|---|
| config /passport.js | Passport Local и OAuth Strategies, плюс промежуточное программное обеспечение. |
| Контроллеры /AAPI.JS | Контроллер для /API -маршрута и все примеры API. |
| контроллеры /contact.js | Контроллер для контактной формы. |
| Контроллеры /HOME.JS | Контроллер для домашней страницы (индекс). |
| Controllers /User.js | Контроллер для управления учетной записью пользователя. |
| модели /user.js | Монгуз схема и модель для пользователя. |
| публичный / | Статические активы (шрифты, CSS, JS, IMG). |
| public / js / application.js | Укажите клиентские зависимости JavaScript. |
| public / js / app.js | Поместите здесь свой клиент JavaScript. |
| public / css / main.scss | Основная таблица стилей для вашего приложения. |
| Просмотры /учетная запись / | Шаблоны для входа в систему, сброса пароля, регистрации, профиля . |
| Просмотры /API / | Шаблоны для примеров API. |
| Просмотры /Частичные /Флэш.pug | Ошибка, информация и успех флэш -уведомления. |
| Просмотры /Частичные /Годдер.pug | Navbar Partial Stemplate. |
| Просмотры /частичные /футер.pug | Перионерный шаблон нижней части нижней части. |
| Views /layout.pug | Базовый шаблон. |
| Views /Hhome.pug | Шаблон домашней страницы. |
| .dockerignore | Папка и файлы игнорируются при использовании Docker. |
| .env.Example | Ваши клавиши API, токены, пароли и URI базы данных. |
| .eslintrc | Правила для Eslint Linter. |
| .gitignore | Папка и файлы игнорируются git. |
| app.js | Основной файл приложения. |
| Docker-Compose.yml | Docker Compose Configuration File. |
| Dockerfile | Файл конфигурации Docker. |
| Package.json | NPM -зависимости. |
| Package-lock.json | Содержит точные версии зависимостей NPM в package.json. |
Примечание: нет предпочтения, как вы называете или структурируете свои представления. Вы можете разместить все свои шаблоны в каталог views верхнего уровня, не имея вложенной структуры папок, если это облегчает вам ситуацию. Только не забудьте обновить extends ../layout и соответствующие пути res.render() в контроллерах.
| Упаковка | Описание |
|---|---|
| @Fortawesome/Fontawesome | Символ и библиотека значков. |
| @Googleapis/Drive | Библиотека интеграции Google Drive API. |
| @googleapis/листы | Google Sheets API интеграционная библиотека. |
| @ladjs/bootstrap-social | Библиотека социальных кнопок. |
| @lob/lob-typescript-sdk | LOB (USPS по почте / Служба физической рассылки) Библиотека. |
| @node-rs/bcrypt | Библиотека для хеширования и солирования паролей пользователей. |
| @octokit/rest | Библиотека GitHub API. |
| @passport-js/passport-twitter | X (Twitter) Поддержка входа в систему (OAuth 2). |
| @popperjs/core | Frontend JS Library для Poppers и подсказки. |
| Аксиос | Http client. |
| Бодитель | Node.js Промежуточное программное обеспечение. |
| начальная загрузка | CSS Framework. |
| чай | Библиотека утверждений BDD/TDD. |
| Cheerio | Скрейп веб-страниц с использованием синтаксиса в стиле jQuery. |
| сжатие | Node.js Compression Middleware. |
| Connect-Mongo | Session Store MongoDB для Express. |
| Dotenv | Загружает переменные среды из файла .env. |
| ErryHandler | Промежуточное программное обеспечение для обработчика ошибок. |
| Эслинт | Линтер JavaScript. |
| eslint-config-airbnb-base | Конфигурация Eslint от Airbnb. |
| Eslint-Plugin-Chai Friendy | Делает Eslint дружелюбным к Chai.js 'wearm' and 'должен' утверждения. |
| Eslint-Plugin-Import | Плагин Eslint с правилами, которые помогают проверить надлежащий импорт. |
| выражать | Node.js Web Framework. |
| экспресс-флаш | Предоставляет флэш -сообщения для Express. |
| экспресс-показатель | Ограничение промежуточного программного обеспечения для защиты от злоупотреблений. |
| экспресс-сессия | Простое промежуточное программное обеспечение для сеанса для экспресса. |
| хаски | Git Hook Manager для автоматизации задач с GIT. |
| jQuery | Библиотека JS Front-End для взаимодействия с HTML-элементами. |
| последний | Last.fm API Библиотека. |
| Стадия ворса | Утилита, чтобы прорвать файлы, поставленные GIT. |
| лоб | LOB API Библиотека. |
| Лодаш | Утилита библиотека для работы с массивами, числами, объектами, строками. |
| Луска | Промежуточное программное обеспечение CSRF. |
| Mailchecker | Проверяет, что адрес электронной почты действителен, а не одноразовый адрес. |
| мокко | Тестовая структура. |
| мгновенный | ПАН, ПРОВЕРИТЬ, вычислить даты и время. |
| Mongodbmemoryserver | MongoDB в памяти (для выполнения тестов без работы DB). |
| мангуста | MongoDB ODM. |
| Морган | HTTP -запрос Logger Промежуточное программное обеспечение для node.js. |
| воодушевление | Node.js Промежуточное программное обеспечение для обработки multipart/form-data . |
| Nodmailer | Библиотека Node.js для отправки электронных писем. |
| Нью -Йорк | Тест на покрытие. |
| паспорт | Простая и элегантная библиотека аутентификации для node.js. |
| Паспорт-образе | Вход с плагином Facebook. |
| паспорт-github2 | Вход с плагином GitHub. |
| Паспорт-Гугл-Оат | Вход в плагин Google. |
| Паспорт-Linkedin-OAuth2 | Вход в плагин LinkedIn. |
| паспорт-локаль | Вход в плагин имени пользователя и пароль. |
| Паспорт-Оат | Позволяет настроить свои собственные стратегии OAuth 1.0a и OAuth 2.0. |
| Passport-OAUTH2-REFRESH | Библиотека для обновления токенов доступа OAuth 2.0 с использованием токенов обновления. |
| Паспорт-Снапчат | Вход с плагином Snapchat. |
| Паспорт-Стим-Опенид | OpenID 2.0 плагин Steam. |
| патч-пакет | Исправьте сломанные модули узла перед исправлениями со стороны сопровождающих. |
| Paypal-Rest-Sdk | Библиотека APIS PayPal. |
| мопс | Шаблонный двигатель для экспресса. |
| набережный | Компилятор SASS для генерации CSS с суперспособными |
| Синон | Тестовые шпионы, заглушки и издевательства за JavaScript. |
| полоса | Библиотека API Offical Stripe. |
| супер -тест | Библиотека утверждений HTTP. |
| Твилио | Библиотека API Twilio. |
| Twitch-Passport | Вход с плагином Twitch. |
| валидатор | Библиотека из строковых валидаторов и дезинфицирующих средств. |
filesize(265318); // "265.32 kB" .var token = _.find(req.user.tokens, { kind: 'twitter' }); , где 1 -й параметр является массивом, а 2 -й параметр - это объект для поиска. 403 Error: Forbidden при отправке формы?Вам нужно добавить следующий скрытый входной элемент в свою форму. Это было добавлено в запросе № 40 в рамках защиты CSRF.
input(type='hidden', name='_csrf', value=_csrf)
Примечание: теперь можно белоснуть определенные URL -адреса. Другими словами, вы можете указать список маршрутов, которые должны обойти проверку проверки CSRF.
Примечание 2: Для динамических URL -адресов белого списка используются регулярные тесты выражения внутри промежуточного программного обеспечения CSRF, чтобы увидеть, соответствует ли req.originalUrl ваш желаемую картину.
Это пользовательское сообщение об ошибке, определенное в app.js чтобы указать, что была проблема, связанная с MongoDB:
mongoose . connection . on ( 'error' , ( err ) => {
console . error ( err ) ;
console . log ( '%s MongoDB connection error. Please make sure MongoDB is running.' , chalk . red ( '✗' ) ) ;
process . exit ( ) ;
} ) ; Перед запуском app.js должен быть сервер MongoDB. Вы можете скачать MongoDB здесь или установить его через диспетчер пакетов. Пользователи Windows, прочитайте установку MongoDB на Windows.
Совет: если вы всегда подключены к Интернету, вы можете просто использовать MongoDB Atlas вместо загрузки и установки MongoDB локально. Вам нужно будет только обновить учетные данные базы данных в файле .env .
Скорее всего, вы не изменили URI базы данных в .env . Если MONGODB установлен на localhost , он будет работать на вашей машине только до тех пор, пока работает MongoDB. Когда вы развернетесь для рендеринга, OpenShift или какого -либо другого поставщика, у вас не будет MongoDB, работающего на localhost . Вам необходимо создать учетную запись в MongoDB Atlas, а затем создать бесплатную базу данных уровней. См. Развертывание для получения дополнительной информации о том, как настроить учетную запись и новую базу данных по шагам с MongoDB Atlas.
Ради простоты. Несмотря на то, что может быть лучший подход, такой как передача контекста app каждому контроллеру, как указано в этом блоге, я считаю, что такой стиль сбивает с толку для начинающих. Мне потребовалось много времени, app понять концепцию exports и module.exports . Для меня это отсталое мышление. app.js - это «Сердце приложения», это должно быть единственным ссылком моделей, маршрутов, контроллеров и т. Д. Когда я работаю над небольшими проектами, я предпочитаю иметь все внутри app.js , как и в случае с этим сервером API REST.
Этот раздел предназначен для того, чтобы дать вам подробное объяснение того, как работает конкретная функциональность. Может быть, вам просто интересно, как это работает, или, возможно, вы потеряны и смущены во время чтения кода, я надеюсь, что он дает вам некоторое руководство.
У HTML5 UP есть много красивых шаблонов, которые вы можете скачать бесплатно.
Когда вы загружаете zip -файл, он будет поставляться с Index.html , изображениями , CSS и JS . Итак, как вы интегрируете его с Hackathon Starter? Hackathon Starter использует Framework Bootstrap CSS, но эти шаблоны этого не делают. Попытка использовать оба файла CSS одновременно, вероятно, приведет к нежелательным эффектам.
ПРИМЕЧАНИЕ. Используя подход на пользовательских шаблонах, вы должны понимать, что вы не можете повторно использовать любое из созданных я просмотров: макет, домашняя страница, браузер API, вход в систему, регистрация, управление учетными записями, контакт. Эти виды были построены с использованием сетки начальной загрузки и стилей. Вам придется вручную обновить сетку, используя другой синтаксис, предоставленный в шаблоне. Сказав это, вы можете смешать и сочетать, если хотите это сделать: используйте начальную загрузку для основного интерфейса приложения и пользовательский шаблон для целевой страницы.
Давайте начнем с начала. Для этого примера я буду использовать шаблон скорости побега:
Примечание. Для простоты я рассмотрю только index.html и пропустить left-sidebar.html Html, no-sidebar.html , right-sidebar.html .
Переместите все файлы JavaScript от html5up-escape-velocity/js в public/js . Затем переместите все файлы CSS из html5up-escape-velocity/css в public/css . И, наконец, перемещайте все изображения из html5up-escape-velocity/images на public/images . Вы можете переместить его в существующую папку IMG , но это потребовало бы вручную изменение каждой ссылки img . Возьмите содержимое index.html и вставьте его в HTML в мопс.
Примечание. Не забудьте соответственно обновить все пути CSS и JS.
Создайте новый файл escape-velocity.pug и вставьте наценку мопса в папку views . Всякий раз, когда вы видите код res.render('account/login') - это означает, что он будет искать views/account/login.pug .
Посмотрим, как это выглядит. Создайте новую контролеровскую версию внутри controllers/home.js :
exports . escapeVelocity = ( req , res ) => {
res . render ( 'escape-velocity' , {
title : 'Landing Page'
} ) ;
} ; А затем создайте маршрут в app.js Я поместил его сразу после контроллера индекса:
app . get ( '/escape-velocity' , homeController . escapeVelocity ) ; Перезапустите сервер (если вы не используете Nodemon ); Затем вы должны увидеть новый шаблон по адресу http://localhost:8080/escape-velocity
Я остановлюсь прямо здесь, но если вы хотите использовать этот шаблон как не только одну страницу, посмотрите, как работают эти шаблоны мопса: layout.pug - базовый шаблон, index.pug - домашняя страница, partials/header.pug partials/footer.pug . Вам придется вручную разбить его на более мелкие кусочки. Выясните, какую часть шаблона вы хотите сохранить одинаковую на всех страницах - это ваш новый layout.pug . Затем каждая страница, которая меняется, будь то index.pug , about.pug , contact.pug будет встроен в ваш новый layout.pug через block content . Используйте существующие шаблоны в качестве ссылки.
Это довольно длительный процесс, и шаблоны, которые вы получаете из других мест, могут иметь еще одну сетку. Вот почему я выбрал начальную загрузку для стартового хакатона. Многие люди уже знакомы с начальной загрузкой , плюс легко начать с него, если вы никогда не использовали начальную загрузку . Вы также можете купить много красиво оформленных тем Bootstrap в Themeforest и использовать их в качестве замены для Hackathon Starter. Однако, если вы хотите пойти с совершенно пользовательским дизайном HTML/CSS, это должно помочь вам начать!
Флэш -сообщения позволяют отображать сообщение в конце запроса и получить доступ к нему по следующему запросу и только следующий запрос. Например, в результате неудачной попытки входа в систему вы отобразили бы предупреждение с некоторым сообщением об ошибке, но как только вы обновите эту страницу или посетите другую страницу и вернетесь на страницу входа в систему, это сообщение об ошибке исчезло. Он отображается только один раз. Этот проект использует модуль Express-Flash для флэш-сообщений. И этот модуль построен на вершине подключения , который я изначально использовал в этом проекте. С Express-Flash вам не нужно явно отправлять флэш-сообщение в каждое представление внутри res.render() . Все флэш-сообщения доступны в ваших представлениях через объект messages по умолчанию, благодаря Express-Flash .
Флэш-сообщения имеют двухэтапный процесс. Вы используете req.flash('errors', { msg: 'Error messages goes here' } чтобы создать флэш -сообщение в ваших контроллерах, а затем отображать их в своих представлениях:
if messages . errors
.alert.alert-danger.fade.in
for error in messages . errors
div = error . msg На первом этапе 'errors' - это имя флэш -сообщения, которое должно соответствовать имени свойства на объекте messages в ваших представлениях. Вы размещаете предупреждающие сообщения внутрь, if message.errors , потому что вы не хотите показывать им флэш -сообщения присутствуют. Причина, по которой вы передаете ошибку, такую как { msg: 'Error message goes here' } вместо строки - 'Error message goes here' , для согласованности. Чтобы прояснить, что модуль Express-Validator , который используется для проверки и дезинфицирования ввода пользователя, возвращает все ошибки в качестве массива объектов, где каждый объект имеет свойство msg с сообщением, почему произошла ошибка. Вот более общий пример того, что возвращает экспресс-валидатор, когда присутствуют ошибки:
[
{ param : "name" , msg : "Name is required" , value : "<received input>" } ,
{ param : "email" , msg : "A valid email is required" , value : "<received input>" }
] Чтобы оставаться в соответствии с этим стилем, вы должны передавать все флэш -сообщения как { msg: 'My flash message' } вместо строки. В противном случае вы увидите поле оповещения без сообщения об ошибке. Это связано с тем, что в шаблоне Partials/Flash.pug он попытается вывести error.msg (то есть "My flash message".msg ), другими словами, он попытается вызвать метод msg на строковом объекте, который вернет неопределенную . Все, что я только что упомянул об ошибках, также относится к «информации» и «успеха» флэш -сообщения, и вы можете даже создать новую самостоятельно, например:
Контроллер использования данных (пример)
req.flash('warning', { msg: 'You have exceeded 90% of your data usage' });
Страница учетной записи пользователя (пример)
if messages . warning
.alert.alert-warning.fade.in
for warning in messages . warning
div = warning . msg partials/flash.pug - это частичный шаблон, который содержит то, как отформатируются флэш -сообщения. Ранее вспышки были разбросаны по каждому представлению, в которых использовались флэш -сообщения (контакт, вход в систему, регистрация, профиль), но теперь, к счастью, он использует сухой подход.
Частичный шаблон флэш -сообщений включен в layout.pug .
body
include partials/header
.container
include partials/flash
block content
include partials/footerЕсли у вас есть какие-либо дополнительные вопросы о флэш-сообщениях, пожалуйста, не стесняйтесь открыть проблему, и я соответствующим образом обновлю этот мини-гибель или отправлю запрос на привлечение, если вы хотите включить то, что я пропустил.
Более правильный способ сказать, что это будет "Как мне создать новый маршрут?" The main file app.js contains all the routes. Each route has a callback function associated with it. Sometimes you will see three or more arguments for a route. In a case like that, the first argument is still a URL string, while middle arguments are what's called middleware. Think of middleware as a door. If this door prevents you from continuing forward, you won't get to your callback function. One such example is a route that requires authentication.
app . get ( '/account' , passportConfig . isAuthenticated , userController . getAccount ) ; It always goes from left to right. A user visits /account page. Then isAuthenticated middleware checks if you are authenticated:
exports . isAuthenticated = ( req , res , next ) => {
if ( req . isAuthenticated ( ) ) {
return next ( ) ;
}
res . redirect ( '/login' ) ;
} ; If you are authenticated, you let this visitor pass through your "door" by calling return next(); Полем It then proceeds to the next middleware until it reaches the last argument, which is a callback function that typically renders a template on GET requests or redirects on POST requests. In this case, if you are authenticated, you will be redirected to the Account Management page; otherwise, you will be redirected to the Login page.
exports . getAccount = ( req , res ) => {
res . render ( 'account/profile' , {
title : 'Account Management'
} ) ;
} ; Express.js has app.get , app.post , app.put , app.delete , but for the most part, you will only use the first two HTTP verbs, unless you are building a RESTful API. If you just want to display a page, then use GET , if you are submitting a form, sending a file then use POST .
Here is a typical workflow for adding new routes to your application. Let's say we are building a page that lists all books from the database.
Step 1. Start by defining a route.
app . get ( '/books' , bookController . getBooks ) ;Note: As of Express 4.x you can define your routes like so:
app . route ( '/books' )
. get ( bookController . getBooks )
. post ( bookController . createBooks )
. put ( bookController . updateBooks )
. delete ( bookController . deleteBooks )And here is how a route would look if it required an authentication and an authorization middleware:
app . route ( '/api/twitter' )
. all ( passportConfig . isAuthenticated )
. all ( passportConfig . isAuthorized )
. get ( apiController . getTwitter )
. post ( apiController . postTwitter ) Use whichever style makes sense to you. Either one is acceptable. I think that chaining HTTP verbs on app.route is a very clean and elegant approach, but on the other hand, I can no longer see all my routes at a glance when you have one route per line.
Step 2. Create a new schema and a model Book.js inside the models directory.
const mongoose = require ( 'mongoose' ) ;
const bookSchema = new mongoose . Schema ( {
name : String
} ) ;
const Book = mongoose . model ( 'Book' , bookSchema ) ;
module . exports = Book ; Step 3. Create a new controller file called book.js inside the controllers directory.
/**
* GET /books
* List all books.
*/
const Book = require ( '../models/Book.js' ) ;
exports . getBooks = ( req , res ) => {
Book . find ( ( err , docs ) => {
res . render ( 'books' , { books : docs } ) ;
} ) ;
} ; Step 4. Import that controller in app.js .
const bookController = require ( './controllers/book' ) ; Step 5. Create books.pug template.
extends layout
block content
.page-header
h3 All Books
ul
for book in books
li = book . nameВот и все! I will say that you could have combined Step 1, 2, 3 as following:
app . get ( '/books' , ( req , res ) => {
Book . find ( ( err , docs ) => {
res . render ( 'books' , { books : docs } ) ;
} ) ;
} ) ; Sure, it's simpler, but as soon as you pass 1000 lines of code in app.js it becomes a little challenging to navigate the file. I mean, the whole point of this boilerplate project was to separate concerns, so you could work with your teammates without running into MERGE CONFLICTS . Imagine you have four developers working on a single app.js , I promise you it won't be fun resolving merge conflicts all the time. If you are the only developer, then it's okay. But as I said, once it gets up to a certain LoC size, it becomes difficult to maintain everything in a single file.
That's all there is to it. Express.js is super simple to use. Most of the time you will be dealing with other APIs to do the real work: Mongoose for querying database, socket.io for sending and receiving messages over WebSockets, sending emails via Nodemailer, form validation using validator.js library, parsing websites using Cheerio, etc.
Dan Stroot submitted an excellent pull request that adds a real-time dashboard with socket.io. And as much as I'd like to add it to the project, I think it violates one of the main principles of the Hackathon Starter:
When I started this project, my primary focus was on simplicity and ease of use. I also tried to make it as generic and reusable as possible to cover most use cases of hackathon web apps, without being too specific .
When I need to use socket.io, I really need it, but most of the time - I don't. But more importantly, WebSockets support is still experimental on most hosting providers. Due to past provider issues with WebSockets, I have not include socket.io as part of the Hackathon Starter. For now... If you need to use socket.io in your app, please continue reading.
First, you need to install socket.io:
npm install socket . io Replace const app = express(); со следующим кодом:
const app = express ( ) ;
const server = require ( 'http' ) . Server ( app ) ;
const io = require ( 'socket.io' ) ( server ) ; I like to have the following code organization in app.js (from top to bottom): module dependencies, import controllers, import configs, connect to database, express configuration, routes, start the server, socket.io stuff. That way I always know where to look for things.
Add the following code at the end of app.js :
io . on ( 'connection' , ( socket ) => {
socket . emit ( 'greet' , { hello : 'Hey there browser!' } ) ;
socket . on ( 'respond' , ( data ) => {
console . log ( data ) ;
} ) ;
socket . on ( 'disconnect' , ( ) => {
console . log ( 'Socket disconnected' ) ;
} ) ;
} ) ;One last thing left to change:
app . listen ( app . get ( 'port' ) , ( ) => {к
server . listen ( app . get ( 'port' ) , ( ) => {At this point, we are done with the back-end.
You now have a choice - to include your JavaScript code in Pug templates or have all your client-side JavaScript in a separate file - in app.js . I admit, when I first started with Node.js and JavaScript in general, I placed all JavaScript code inside templates because I have access to template variables passed in from Express right then and there. It's the easiest thing you can do, but also the least efficient and harder to maintain. Since then I almost never include inline JavaScript inside templates anymore.
But it's also understandable if you want to take the easier road. Most of the time you don't even care about performance during hackathons, you just want to "get shit done" before the time runs out. Well, either way, use whichever approach makes more sense to you. At the end of the day, it's what you build that matters, not how you build it.
If you want to stick all your JavaScript inside templates, then in layout.pug - your main template file, add this to head block.
script ( src = '/socket.io/socket.io.js' )
script .
let socket = io . connect ( window . location . href );
socket . on ( ' greet ' , function ( data ) {
console . log (data);
socket . emit ( ' respond ' , { message : ' Hey there, server! ' });
}); Note: Notice the path of the socket.io.js , you don't actually have to have socket.io.js file anywhere in your project; it will be generated automatically at runtime.
If you want to have JavaScript code separate from templates, move that inline script code into app.js , inside the $(document).ready() function:
$ ( document ) . ready ( function ( ) {
// Place JavaScript code here...
let socket = io . connect ( window . location . href ) ;
socket . on ( 'greet' , function ( data ) {
console . log ( data ) ;
socket . emit ( 'respond' , { message : 'Hey there, server!' } ) ;
} ) ;
} ) ;And we are done!
Declares a read-only named constant.
const name = 'yourName' ;Declares a block scope local variable.
let index = 0 ; Using the `${}` syntax, strings can embed expressions.
const name = 'Oggy' ;
const age = 3 ;
console . log ( `My cat is named ${ name } and is ${ age } years old.` ) ; To import functions, objects, or primitives exported from an external module. These are the most common types of importing.
const name = require ( 'module-name' ) ; const { foo , bar } = require ( 'module-name' ) ;To export functions, objects, or primitives from a given file or module.
module . exports = { myFunction } ; module . exports . name = 'yourName' ; module . exports = myFunctionOrClass ; The spread operator allows an expression to be expanded in places where multiple arguments (for function calls) or multiple elements (for array literals) are expected.
myFunction ( ... iterableObject ) ; < ChildComponent { ... this . props } /> A Promise is used in asynchronous computations to represent an operation that hasn't completed yet but is expected in the future.
var p = new Promise ( function ( resolve , reject ) { } ) ; The catch() method returns a Promise and deals with rejected cases only.
p . catch ( function ( reason ) { /* handle rejection */ } ) ; The then() method returns a Promise. It takes two arguments: callback for the success & failure cases.
p . then ( function ( value ) { /* handle fulfillment */ } , function ( reason ) { /* handle rejection */ } ) ; The Promise.all(iterable) method returns a promise that resolves when all of the promises in the iterable argument have resolved or rejects with the reason of the first passed promise that rejects.
Promise . all ( [ p1 , p2 , p3 ] ) . then ( function ( values ) { console . log ( values ) } ) ; Arrow function expression. Shorter syntax & lexically binds the this value. Arrow functions are anonymous.
singleParam => { statements } ( ) => { statements } ( param1 , param2 ) => expression const arr = [ 1 , 2 , 3 , 4 , 5 ] ;
const squares = arr . map ( x => x * x ) ; The class declaration creates a new class using prototype-based inheritance.
class Person {
constructor ( name , age , gender ) {
this . name = name ;
this . age = age ;
this . gender = gender ;
}
incrementAge ( ) {
this . age ++ ;
}
}? Credits : DuckDuckGo and @DrkSephy.
? back to top
Math . floor ( Date . now ( ) / 1000 ) ; moment().unix();
var now = new Date ( ) ;
now . setMinutes ( now . getMinutes ( ) + 30 ) ; moment().add(30, 'minutes');
// DD-MM-YYYY
var now = new Date ( ) ;
var DD = now . getDate ( ) ;
var MM = now . getMonth ( ) + 1 ;
var YYYY = now . getFullYear ( ) ;
if ( DD < 10 ) {
DD = '0' + DD ;
}
if ( MM < 10 ) {
MM = '0' + MM ;
}
console . log ( MM + '-' + DD + '-' + YYYY ) ; // 03-30-2016 console.log(moment(new Date(), 'MM-DD-YYYY'));
// hh:mm (12 hour time with am/pm)
var now = new Date ( ) ;
var hours = now . getHours ( ) ;
var minutes = now . getMinutes ( ) ;
var amPm = hours >= 12 ? 'pm' : 'am' ;
hours = hours % 12 ;
hours = hours ? hours : 12 ;
minutes = minutes < 10 ? '0' + minutes : minutes ;
console . log ( hours + ':' + minutes + ' ' + amPm ) ; // 1:43 am console.log(moment(new Date(), 'hh:mm A'));
var today = new Date ( ) ;
var nextWeek = new Date ( today . getTime ( ) + 7 * 24 * 60 * 60 * 1000 ) ; moment().add(7, 'days');
var today = new Date ( ) ;
var yesterday = date . setDate ( date . getDate ( ) - 1 ) ; moment().add(-1, 'days');
? back to top
User . find ( ( err , users ) => {
console . log ( users ) ;
} ) ; let userEmail = '[email protected]' ;
User . findOne ( { email : userEmail } , ( err , user ) => {
console . log ( user ) ;
} ) ; User
. find ( )
. sort ( { _id : - 1 } )
. limit ( 5 )
. exec ( ( err , users ) => {
console . log ( users ) ;
} ) ; Let's suppose that each user has a votes field and you would like to count the total number of votes in your database across all users. One very inefficient way would be to loop through each document and manually accumulate the count. Or you could use MongoDB Aggregation Framework instead:
User . aggregate ( { $group : { _id : null , total : { $sum : '$votes' } } } , ( err , votesCount ) => {
console . log ( votesCount . total ) ;
} ) ;? back to top
You will need to install docker and docker-compose on your system. If you are using WSL, you will need to install Docker Desktop on Windows and docker-compose on WSL.
Docker installation
Common problems setting up docker
After installing docker, start the application with the following commands :
# To build the project while supressing most of the build messages
docker-compose build web
# To build the project without supressing the build messages or using cached data
docker-compose build --no-cache --progress=plain web
# To start the application (or to restart after making changes to the source code)
docker-compose up web
To view the app, find your docker IP address + port 8080 ( this will typically be http://localhost:8080/ ). To use a port other than 8080, you would need to modify the port in app.js, Dockerfile, and docker-compose.yml.
Once you are ready to deploy your app, you will need to create an account with a cloud platform to host it. These are not the only choices, but they are my top picks. Additionally, you can create an account with MongoDB Atlas and then pick one of the providers below. Again, there are plenty of other choices, and you are not limited to just the ones listed below.
Render provides free nodejs hosting for repos on Github and Gitlab.
0.0.0.0/0 . Click SAVE to save the 0.0.0.0/0 whitelist..env.example with this URI string. Make sure to replace the with the db User password that you created under the Security tab.We are deploying your changes . You will need to wait for the deployment to finish before using the DB in your application.sudo gem install rhc ?rhc login and enter your OpenShift credentialsrhc app create MyApp nodejs-0.10git remote add openshift YOUR_GIT_REMOTE Add these two lines to app.js , just place them anywhere before app.listen() :
var IP_ADDRESS = process . env . OPENSHIFT_NODEJS_IP || '127.0.0.1' ;
var PORT = process . env . OPENSHIFT_NODEJS_PORT || 8080 ; Then change app.listen() to:
app . listen ( PORT , IP_ADDRESS , ( ) => {
console . log ( `Express server listening on port ${ PORT } in ${ app . settings . env } mode` ) ;
} ) ; Add this to package.json , after name and version . This is necessary because, by default, OpenShift looks for server.js file. And by specifying supervisor app.js it will automatically restart the server when node.js process crashes.
"main" : "app.js" ,
"scripts" : {
"start" : "supervisor app.js"
} ,git push -f openshift master-f (force) flag because OpenShift creates a dummy server with the welcome page when you create a new Node.js app. Passing -f flag will override everything with your Hackathon Starter project repository. Do not run git pull as it will create unnecessary merge conflicts.git remote add azure [Azure Git URL]git push azure masterNOTE At this point it appears that Bluemix's free tier to host NodeJS apps is limited to 30 days. If you are looking for a free tier service to host your app, Render might be a better choice at this point
Create a Bluemix Account
Sign up for Bluemix, or use an existing account.
Download and install the Cloud Foundry CLI to push your applications to Bluemix.
Create a manifest.yml file in the root of your application.
applications:
- name: <your-app-name>
host: <your-app-host>
memory: 128M
services:
- myMongo-db-name
The host you use will determinate your application URL initially, eg <host>.mybluemix.net . The service name 'myMongo-db-name' is a declaration of your MongoDB service. If you are using other services like Watson for example, then you would declare them the same way.
$ cf login -a https://api.ng.bluemix.net
$ cf create-service mongodb 100 [your-service-name]
Note: this is a free and experiment verion of MongoDB instance. Use the MongoDB by Compose instance for production applications:
$ cf create-service compose-for-mongodb Standard [your-service-name]'
Push the application
$ cf push
$ cf env <your-app-name >
(To view the *environment variables* created for your application)
Done , now go to the staging domain ( <host>.mybluemix.net ) and see your app running.
Be sure to check out the full list of Watson services to forwarder enhance your application functionality with a little effort. Watson services are easy to get going; it is simply a RESTful API call. Here is an example of a Watson Toner Analyzer to understand the emotional context of a piece of text that you send to Watson.
Virtual Assistant - Deliver consistent and intelligent customer care across all channels and touchpoints with conversational AI.
Natural Language Understanding - Analyze text to extract meta-data from content such as concepts, entities, keywords and more.
Discovery - Accelerate business decisions and processes with an AI-powered intelligent document understanding and content analysis platform.
Orchestrate - Hand off tedious tasks to Watson and never work the same way again.
List of Watson Services.
Download and install Node.js
Select or create a Google Cloud Platform Console project
Enable billing for your project (there's a $300 free trial)
Install and initialize the Google Cloud SDK
Create an app.yaml file at the root of your hackathon-starter folder with the following contents:
runtime : nodejs
env : flex
manual_scaling :
instances : 1 Make sure you've set MONGODB_URI in .env.example
Run the following command to deploy the hackathon-starter app:
gcloud app deployMonitor your deployed app in the Cloud Console
View the logs for your app in the Cloud Console
If you are starting with this boilerplate to build an application for prod deployment, or if after your hackathon you would like to get your project hardened for production use, see prod-checklist.md.
You can find the changelog for the project in: CHANGELOG.md
If something is unclear, confusing, or needs to be refactored, please let me know. Pull requests are always welcome, but due to the opinionated nature of this project, I cannot accept every pull request. Please open an issue before submitting a pull request. This project uses Airbnb JavaScript Style Guide with a few minor exceptions. If you are submitting a pull request that involves Pug templates, please make sure you are using spaces , not tabs.
Лицензия MIT (MIT)
Copyright (c) 2014-2023 Sahat Yalkabov
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
