codu

Код

Пространство для кодеров

Codú является конечным сообществом веб -разработчиков, чтобы изучать, делиться и получить поддержку для ваших проектов, больших или маленьких. Это идеальное место, чтобы обострить ваши навыки и построить ваше портфолио. В Codú мы все здесь, чтобы помочь друг другу расти как веб -разработчики. Кроме того, Codú облегчает поиск сотрудников для вашего следующего большого проекта.

---

Присоединяйтесь к разговору

У нас есть фантастическое сообщество, растущее на раздорах. Нажмите здесь, чтобы присоединиться!

---

Установка

1. Форк проект
2. Клон с git clone https://github.com/YOUR_USERNAME/codu.git .
3. Перейдите к cd codu Directory Project.
4. Установите зависимости с:

npm install

• Если у вас есть какие -либо проблемы с установкой зависимостей, проверьте версию узла в отношении определения в .nvmrc . Если вы используете nvm , вы можете запустить nvm use перед установкой зависимостей.

5. Создайте файл .env и добавьте следующие переменные. Вы можете скопировать содержимое sample.env с помощью cat sample.env > .env .

 # This default value is if you run our local docker-compose.yml file to create the database.
DATABASE_URL=postgresql://postgres:[email protected]:5432/postgres
# Setup your GitHub ID & Secret on GitHub: https://developer.github.com/apps/building-oauth-apps/authorizing-oauth-apps
# For development, make sure you set up this with a Homepage URL of http://localhost:3000/ and an Authorization callback URL of http://localhost:3000/api/auth
GITHUB_ID=YOUR_GITHUB_APP_ID
GITHUB_SECRET=YOUR_GITHUB_APP_SECRET
NEXTAUTH_URL=http://localhost:3000/api/auth

Для более подробного руководства по их настройке перейдите в раздел переменных среды.

Примечание. Перед продолжением убедитесь, что ваша база данных работает.

6. Установите таблицы в базе данных с дождем, работая:

npm run db:migrate

Полную команду можно увидеть в нашем файле Package.json.

7. Запустить базу данных некоторыми макетными данными, работая:

npm run db:seed

Полную команду можно увидеть в нашем файле Package.json.

8. Наконец, запустите сервер разработки:

npm run dev

После завершения вышеупомянутых команд перейдите к http: // localhost: 3000 в вашем браузере, чтобы увидеть результат.

Вы можете начать свое путешествие с изменения pages/index.tsx . С помощью функции Auto-Update обновите страницы при редактировании файла.

Каталог pages/api сопоставлен /api/* . Файлы в этом каталоге рассматриваются как маршруты API вместо страниц реагирования.

Узнайте больше о маршрутах API здесь.

Переменные среды

Database_url

DATABASE_URL - это строка подключения к базе данных PostgreSQL (версия 15.0).

По умолчанию мы указываем на базу данных, работающую локально с Docker из нашего файла docker-compose.yml .

Чтобы запустить этот файл, убедитесь, что у вас установлен Docker, и этот Docker работает.

Запустите команду docker compose up .

В качестве альтернативы, если у вас работает PostgreSQL локально, вы можете использовать свою локальную строку подключения или получить одну из бесплатных сервисов, таких как Supabase.

Github_id и github_secret

В настоящее время мы разрешаем аутентификацию только через GitHub. Чтобы включить это, вам нужно иметь значение GITHUB_ID и GITHUB_SECRET .

Установите свой идентификатор GitHub на GitHub:

• Нажмите здесь, чтобы настроить новое приложение OAuth и заполнить подробности, как показано ниже.

Для развития убедитесь, что вы настроили это с помощью URL -адреса домашней страницы

 http://localhost:3000/

и разрешение на вызов URL

 http://localhost:3000/api/auth

После нажатия кнопки «Зарегистрировать приложение» вы должны увидеть GITHUB_ID и иметь возможность генерировать новый секрет клиента. После создания секрета убедитесь, что вы скопируете это значение в свой файл .env , так как это значение не может быть замечено снова, как только вы обновляете страницу.

Больше информации о разрешении OAuth в документации GitHub здесь.

Настройка автозаветной автозавета локально

Чтобы использовать вход без пароля локально, вам нужно иметь значение ACCESS_KEY и SECRET_KEY .

Проверьте пример файла .env здесь, чтобы увидеть, как заполнить эти значения.

Примечание. В настоящее время регион AWS службы SNS жестко кодируется «ЕС-Вест-1»; Может потребоваться изменить это, если ваша служба SNS находится в другом регионе.

Nextauth_url

Вам не нужно менять значение по умолчанию здесь. Это переменная, используемая Next Auth в качестве URL -адреса аутентификации на ваш сайт.

 NEXTAUTH_URL=http://localhost:3000/api/auth

Пример .ENV -файла можно найти здесь. Вы можете переименовать это в .env , чтобы начать.

‍ Руководство по вкладу

• Вклады высоко ценятся . Вклад делает сообщество с открытым исходным кодом удивительным местом для изучения, вдохновения и создания.
• Ознакомьтесь с нашими руководящими принципами вклада, чтобы внести свой вклад в нашу репо. Это включает в себя
  • Как внести свой вклад
  • Как создать запрос на вытягивание
  • Запустить тесты
  • Руководство по стилю для сообщений о коммите

? Необходимые навыки внести свой вклад

• Git

? Взносы документации

• Отметка

? Кодовые взносы

• Реагировать
• Next.js
• Postgresql
• Попутный ветер
• Дождь

Дополнительные ресурсы

Чтобы узнать больше о следующем.js, посмотрите на следующие ресурсы:

• Next.js Документация - Узнайте о функциях Next.js и API.
• Узнайте Next.js - интерактивный учебник Next.js.

Редактор Док

Чтобы узнать о ярлыках редактора и горячих классах, вы можете проверить этот документ:

• Редактор Markdoc Hotkeys and ярлыки

? E2E тестирование

Для получения информации о тестировании E2E, пожалуйста, обратитесь к нашей специальной документации здесь.

? Проблемы

Вы можете открыть вопросы, чтобы обсудить идеи об улучшении Codú. Улучшения поощряются и ценятся.