readme
This commit is contained in:
		
							parent
							
								
									3c4a999ef7
								
							
						
					
					
						commit
						058f406e2b
					
				
							
								
								
									
										40
									
								
								README.md
								
								
								
								
							
							
						
						
									
										40
									
								
								README.md
								
								
								
								
							|  | @ -1,36 +1,16 @@ | ||||||
| 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). | # Subman | ||||||
|  | ## A self-hosted literary submission manager | ||||||
| 
 | 
 | ||||||
| ## Getting Started | I developed this project as a demonstration of my full-stack development abilities, utilizing: | ||||||
| 
 | 
 | ||||||
| First, run the development server: | - Nextjs | ||||||
|  | - Tailwind | ||||||
|  | - heavily customised Shadcn components | ||||||
|  | - an Sqlite database with Prisma ORM as intermediary | ||||||
| 
 | 
 | ||||||
| ```bash | My previous attempt at this project was a Nodejs server with a React frontend, but this version is much better! | ||||||
| npm run dev |  | ||||||
| # or |  | ||||||
| yarn dev |  | ||||||
| # or |  | ||||||
| pnpm dev |  | ||||||
| # or |  | ||||||
| bun dev |  | ||||||
| ``` |  | ||||||
| 
 | 
 | ||||||
| Open [http://localhost:3000](http://localhost:3000) with your browser to see the result. | ## What it does | ||||||
|  | Subman was inspired by my experiences submitting short fiction to magazines for publication. It allows the user to track where submissions are pending, in addition to meta-data such as genres, word count and so on. What you see here is the Minimum Shippable Product. | ||||||
| 
 | 
 | ||||||
| You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file. |  | ||||||
| 
 | 
 | ||||||
| This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font. |  | ||||||
| 
 |  | ||||||
| ## Learn More |  | ||||||
| 
 |  | ||||||
| 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! |  | ||||||
| 
 |  | ||||||
| ## Deploy on Vercel |  | ||||||
| 
 |  | ||||||
| The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js. |  | ||||||
| 
 |  | ||||||
| Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details. |  | ||||||
|  |  | ||||||
|  | @ -753,6 +753,10 @@ body { | ||||||
|   margin-left: auto; |   margin-left: auto; | ||||||
| } | } | ||||||
| 
 | 
 | ||||||
|  | .mr-2 { | ||||||
|  |   margin-right: 0.5rem; | ||||||
|  | } | ||||||
|  | 
 | ||||||
| .mr-4 { | .mr-4 { | ||||||
|   margin-right: 1rem; |   margin-right: 1rem; | ||||||
| } | } | ||||||
|  | @ -777,10 +781,6 @@ body { | ||||||
|   margin-top: 1.5rem; |   margin-top: 1.5rem; | ||||||
| } | } | ||||||
| 
 | 
 | ||||||
| .mr-2 { |  | ||||||
|   margin-right: 0.5rem; |  | ||||||
| } |  | ||||||
| 
 |  | ||||||
| .block { | .block { | ||||||
|   display: block; |   display: block; | ||||||
| } | } | ||||||
|  | @ -989,8 +989,12 @@ body { | ||||||
|   max-width: 6rem; |   max-width: 6rem; | ||||||
| } | } | ||||||
| 
 | 
 | ||||||
| .max-w-36 { | .max-w-28 { | ||||||
|   max-width: 9rem; |   max-width: 7rem; | ||||||
|  | } | ||||||
|  | 
 | ||||||
|  | .max-w-32 { | ||||||
|  |   max-width: 8rem; | ||||||
| } | } | ||||||
| 
 | 
 | ||||||
| .max-w-60 { | .max-w-60 { | ||||||
|  | @ -1009,18 +1013,6 @@ body { | ||||||
|   max-width: 24rem; |   max-width: 24rem; | ||||||
| } | } | ||||||
| 
 | 
 | ||||||
| .max-w-xs { |  | ||||||
|   max-width: 20rem; |  | ||||||
| } |  | ||||||
| 
 |  | ||||||
| .max-w-32 { |  | ||||||
|   max-width: 8rem; |  | ||||||
| } |  | ||||||
| 
 |  | ||||||
| .max-w-28 { |  | ||||||
|   max-width: 7rem; |  | ||||||
| } |  | ||||||
| 
 |  | ||||||
| .shrink-0 { | .shrink-0 { | ||||||
|   flex-shrink: 0; |   flex-shrink: 0; | ||||||
| } | } | ||||||
|  | @ -1396,6 +1388,11 @@ body { | ||||||
|   padding: 1.5rem; |   padding: 1.5rem; | ||||||
| } | } | ||||||
| 
 | 
 | ||||||
|  | .px-0 { | ||||||
|  |   padding-left: 0px; | ||||||
|  |   padding-right: 0px; | ||||||
|  | } | ||||||
|  | 
 | ||||||
| .px-1 { | .px-1 { | ||||||
|   padding-left: 0.25rem; |   padding-left: 0.25rem; | ||||||
|   padding-right: 0.25rem; |   padding-right: 0.25rem; | ||||||
|  | @ -1456,11 +1453,6 @@ body { | ||||||
|   padding-bottom: 1rem; |   padding-bottom: 1rem; | ||||||
| } | } | ||||||
| 
 | 
 | ||||||
| .px-0 { |  | ||||||
|   padding-left: 0px; |  | ||||||
|   padding-right: 0px; |  | ||||||
| } |  | ||||||
| 
 |  | ||||||
| .pl-3 { | .pl-3 { | ||||||
|   padding-left: 0.75rem; |   padding-left: 0.75rem; | ||||||
| } | } | ||||||
|  | @ -1506,11 +1498,6 @@ body { | ||||||
|   line-height: 2.25rem; |   line-height: 2.25rem; | ||||||
| } | } | ||||||
| 
 | 
 | ||||||
| .text-4xl { |  | ||||||
|   font-size: 2.25rem; |  | ||||||
|   line-height: 2.5rem; |  | ||||||
| } |  | ||||||
| 
 |  | ||||||
| .text-\[0\.8rem\] { | .text-\[0\.8rem\] { | ||||||
|   font-size: 0.8rem; |   font-size: 0.8rem; | ||||||
| } | } | ||||||
|  | @ -2373,18 +2360,10 @@ body { | ||||||
|     display: none; |     display: none; | ||||||
|   } |   } | ||||||
| 
 | 
 | ||||||
|   .sm\:h-4 { |  | ||||||
|     height: 1rem; |  | ||||||
|   } |  | ||||||
| 
 |  | ||||||
|   .sm\:h-6 { |   .sm\:h-6 { | ||||||
|     height: 1.5rem; |     height: 1.5rem; | ||||||
|   } |   } | ||||||
| 
 | 
 | ||||||
|   .sm\:w-4 { |  | ||||||
|     width: 1rem; |  | ||||||
|   } |  | ||||||
| 
 |  | ||||||
|   .sm\:w-6 { |   .sm\:w-6 { | ||||||
|     width: 1.5rem; |     width: 1.5rem; | ||||||
|   } |   } | ||||||
|  |  | ||||||
		Loading…
	
		Reference in New Issue