search

kas-catholic / confessit-web

Source code for https://confessit.app
MIT License
18 stars 7 forks source link
catholic catholicism hacktoberfest

readme

ConfessIt README

This repository contains the source code for https://confessit.app.

We welcome anyone who would like to contribute to this project. Please see our code of conduct for more information. And feel free to get in touch by starting a discussion or commenting on an issue here on GitHub.

Development

  1. We highly recommend using nvm to manage your Node installation. See the nvm Installation Instructions. We have a .nvmrc checked in, so running nvm install in this project directory after setting up nvm will ensure the correct Node version is installed.
  2. We use Yarn 2 to manage our dependencies. The Yarn Installation Instructions recommend running corepack enable to install Yarn.
  3. Install the project dependencies with yarn install.
  4. Run yarn start as described below to build the project and run the development server. You can kill the server with CTRL-C and restart it any time with yarn start again.

This project is a progressive web app React app and was bootstrapped with Create React App. Reading the React and Create React App docs will help you get started if you're not already familiar with these frameworks. We use React Bootstrap as our CSS framework and react-i18next for translations.

See CONTRIBUTING for more information about how to contribute to the development of ConfessIt.

Translations

We want to support more languages, and welcome translation additions and improvements! See CONTRIBUTING for more information about how to add or improve a translation to a different language.

Production Deployment

Our main branch is continuously deployed via Netlify. Simply merge to main and the site will be updated.

Available Scripts

In the project directory, you can run:

yarn start

Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.

yarn test

We don't have any tests yet, but we plan to add some soon.

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

yarn build

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

See the section about deployment for more information.

Learn More

You can learn more in the Create React App documentation.

To learn React, check out the React documentation.

We're also using Swiper via react-id-swiper for the swipable columns.

The app is deployed to https://confessit.app, hosted on Netlify.