nextjstemplate
Biodesign Digital Health NextJS Template
Science Score: 67.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
✓DOI references
Found 3 DOI reference(s) in README -
✓Academic publication links
Links to: zenodo.org -
○Committers with academic emails
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (14.5%) to scientific vocabulary
Keywords
Repository
Biodesign Digital Health NextJS Template
Basic Info
- Host: GitHub
- Owner: StanfordBDHG
- License: mit
- Language: TypeScript
- Default Branch: main
- Homepage: https://stanfordbdhg.github.io/NextJSTemplate/
- Size: 368 KB
Statistics
- Stars: 1
- Watchers: 10
- Forks: 3
- Open Issues: 7
- Releases: 3
Topics
Metadata Files
README.md
Biodesign Digital Health Next.js Template
How To Use This Template
The template repository contains a template for a Next.js project providing automated GitHub Actions and setups for code linting, testing & test coverage reports, docker deployments, a docker compose setup, local packages for modular deployment, and documentation generation & deployment.
Follow these steps to customize it to your needs:
- Rename the Next.js project.
- Modify, add, or remove the local packages found at
/packages/*to separate code into smaller modules. - Add dependencies and edit the project in
/appand the local Node packages.
The main application is automatically deployed to https://stanfordbdhg.github.io/NextJSTemplate/.
The documentation of the local packages is automatically deployed to https://stanfordbdhg.github.io/NextJSTemplate/docs.
Getting Started
You can run the project using the following command. You will need to install Node.js and npm, e.g., using homebrew (recommended for macOS) or the official Node.js installer.
- Install All Dependencies
bash
npm install
- Start the Next.js Application
bash
npm run dev
Open http://localhost:3000 with your browser to see the result.<!-- markdown-link-check-disable-line -->
You can edit the page by modifying app/page.tsx. The page auto-updates as you edit the file.
Docker
- Install Docker on your machine.
- Build the image and run the docker compose setup:
docker compose -f docker-compose-development.yml up.
You can view your images created with docker images.
Open http://localhost with your browser to see the result. You can visit http://localhost:8080 to see the reverse proxy setup before the main application.<!-- markdown-link-check-disable-line -->
The docker-compose.yml setup contains a production-ready setup using a reverse proxy.
Every version of the application on the main branch is automatically packaged into docker images using the main tag. Every release is also published using the latest and respective version tags.
Learn More
To learn more about Next.js, take a look at the following resources:
- Next.js Documentation - learn about Next.js features and API.
- Learn Next.js - an interactive Next.js tutorial.
You can check out the Next.js GitHub repository - your feedback and contributions are welcome!
License
This project is licensed under the MIT License. See Licenses for more information.
Contributors
This project is developed as part of the Stanford Byers Center for Biodesign at Stanford University. See CONTRIBUTORS.md for a full list of all Next.js Template contributors.
Owner
- Name: Stanford Biodesign Digital Health
- Login: StanfordBDHG
- Kind: organization
- Location: United States of America
- Twitter: StanfordBDHG
- Repositories: 18
- Profile: https://github.com/StanfordBDHG
Citation (CITATION.cff)
#
# This source file is part of the Stanford Biodesign Digital Health Next.js Template open-source project
#
# SPDX-FileCopyrightText: 2023 Stanford University and the project authors (see CONTRIBUTORS.md)
#
# SPDX-License-Identifier: MIT
#
cff-version: 1.2.0
message: 'If you use this software, please cite it as below.'
authors:
- family-names: 'Schmiedmayer'
given-names: 'Paul'
orcid: 'https://orcid.org/0000-0002-8607-9148'
- family-names: 'Ravi'
given-names: 'Vishnu'
orcid: 'https://orcid.org/0000-0003-0359-1275'
title: 'NextJSTemplate'
doi: '10.5281/zenodo.10052055'
url: 'https://github.com/StanfordBDHG/NextJSTemplate'
GitHub Events
Total
- Issues event: 2
- Watch event: 1
- Member event: 2
- Pull request review event: 1
Last Year
- Issues event: 2
- Watch event: 1
- Member event: 2
- Pull request review event: 1
Committers
Last synced: 9 months ago
Top Committers
| Name | Commits | |
|---|---|---|
| Paul Schmiedmayer | P****r | 16 |
| Arkadiusz Bachorski | 6****i | 10 |
| Vishnu Ravi | v****i@g****m | 1 |
Issues and Pull Requests
Last synced: 10 months ago
All Time
- Total issues: 10
- Total pull requests: 44
- Average time to close issues: 7 months
- Average time to close pull requests: 9 days
- Total issue authors: 3
- Total pull request authors: 5
- Average comments per issue: 1.0
- Average comments per pull request: 1.02
- Merged pull requests: 39
- Bot issues: 0
- Bot pull requests: 3
Past Year
- Issues: 8
- Pull requests: 23
- Average time to close issues: N/A
- Average time to close pull requests: about 14 hours
- Issue authors: 3
- Pull request authors: 3
- Average comments per issue: 0.25
- Average comments per pull request: 0.87
- Merged pull requests: 20
- Bot issues: 0
- Bot pull requests: 1
Top Authors
Issue Authors
- arkadiuszbachorski (3)
- PSchmiedmayer (2)
- PaulGoldschmidt (1)
Pull Request Authors
- arkadiuszbachorski (19)
- PSchmiedmayer (14)
- dependabot[bot] (3)
- ThomasKaar (1)
- vishnuravi (1)