Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/stuyspec/stuyspec-rewrite
The rewrite of The Stuyvesant Spectator's website!
https://github.com/stuyspec/stuyspec-rewrite
Last synced: 4 days ago
JSON representation
The rewrite of The Stuyvesant Spectator's website!
- Host: GitHub
- URL: https://github.com/stuyspec/stuyspec-rewrite
- Owner: stuyspec
- License: gpl-3.0
- Created: 2021-12-16T03:36:02.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-12-09T20:31:54.000Z (about 1 month ago)
- Last Synced: 2024-12-09T21:29:56.460Z (30 days ago)
- Language: TypeScript
- Homepage: https://beta.stuyspec.com
- Size: 2.55 MB
- Stars: 7
- Watchers: 5
- Forks: 34
- Open Issues: 21
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# stuyspec.com
[](https://github.com/stuyspec/stuyspecrewrite/actions/workflows/vercel.yml)
#
The **new** client-side application of The Stuyvesant Spectator, built using various modern technologies including NextJS, Typescript, and MongoDB
## Getting Started
1. Clone the repository
```bash
git clone https://github.com/stuyspec/stuyspec-rewrite.git
```
2. Install all dependencies
```bash
npm install
# or
yarn
```
3. Set up the `.env.local`
Create a `.env.local` file, with MONGODB_URI being the credentials for your development mongodb database
```bash
# In .env.local
MONGODB_URI=mongodb+srv://...
```
Optionally, add a api token for MailerLite in `MAILERLITE_API_TOKEN`
4. Run the development server:
```bash
npm run dev
# or
yarn dev
```
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
You can start editing the page by modifying `pages/index.tsx`. The page hot reloads as you edit the file.
[API routes](https://nextjs.org/docs/api-routes/introduction) can be accessed on [http://localhost:3000/api/articles](http://localhost:3000/api/articles). This endpoint can be edited in `pages/api/articles/index.ts`.
The `pages/api` directory is mapped to `/api/*`. Files in this directory are treated as [API routes](https://nextjs.org/docs/api-routes/introduction) instead of React pages.
## Running this app with docker
Build the app with docker.
```bash
docker build -t stuyspecrewrite .
```
Next, run the built container.
```bash
docker run -p 127.0.0.1:3000:3000 stuyspecrewrite
```
## Contributing
We welcome pull requests from Spec Web developers and seasoned JavaScript developers alike! Please follow [these steps](CONTRIBUTING.md) to contribute.
## Learn More
This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).
To learn more about Next.js, take a look at the following resources:
- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!
Favicons generated with [realfavicongenerator.net](https://realfavicongenerator.net/)